- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface UrlMapOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCreationTimestamp()
public abstract String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public abstract ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultRouteAction()
public abstract 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. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) 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. |
getDefaultRouteActionOrBuilder()
public abstract 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. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) 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 abstract 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. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must 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 abstract 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. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must 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 abstract HttpRedirectAction getDefaultUrlRedirect()When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not 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. |
getDefaultUrlRedirectOrBuilder()
public abstract HttpRedirectActionOrBuilder getDefaultUrlRedirectOrBuilder()When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not 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 abstract 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 abstract 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. |
getFingerprint()
public abstract String getFingerprint()Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field 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 abstract ByteString getFingerprintBytes()Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field 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 abstract 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. |
getHeaderActionOrBuilder()
public abstract 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 abstract 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 | |
getHostRulesCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getName() Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes() Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getPathMatchers(int index)
public abstract 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 | |
getPathMatchersCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public abstract 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 abstract 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 | |
getTestsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
hasDefaultRouteAction()
public abstract 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. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) 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 abstract 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. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must 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 abstract boolean hasDefaultUrlRedirect()When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not 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 abstract 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 abstract boolean hasFingerprint()Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field 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 abstract 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 abstract 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 abstract 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 abstract boolean hasName() Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the name field is set. |
hasRegion()
public abstract 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 abstract 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. |