Package com.google.cloud.compute.v1

Interface UrlMapOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UrlMap, UrlMap.Builder
@Generated public interface UrlMapOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCreationTimestamp

      boolean hasCreationTimestamp()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      Whether the creationTimestamp field is set.

    • getCreationTimestamp

      String getCreationTimestamp()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      The creationTimestamp.

    • getCreationTimestampBytes

      com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      The bytes for creationTimestamp.

    • hasDefaultCustomErrorResponsePolicy

      boolean hasDefaultCustomErrorResponsePolicy()
       defaultCustomErrorResponsePolicy specifies how the Load
 Balancer returns error responses when BackendServiceorBackendBucket 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 a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced.
 When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When
 a request that does not match any host in *.example.com such
 as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy
 takes effect.

 When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only
 once all retries are exhausted, thedefaultCustomErrorResponsePolicy 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:
      Whether the defaultCustomErrorResponsePolicy field is set.

    • getDefaultCustomErrorResponsePolicy

      CustomErrorResponsePolicy getDefaultCustomErrorResponsePolicy()
       defaultCustomErrorResponsePolicy specifies how the Load
 Balancer returns error responses when BackendServiceorBackendBucket 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 a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced.
 When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When
 a request that does not match any host in *.example.com such
 as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy
 takes effect.

 When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only
 once all retries are exhausted, thedefaultCustomErrorResponsePolicy 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:
      The defaultCustomErrorResponsePolicy.

    • getDefaultCustomErrorResponsePolicyOrBuilder

      CustomErrorResponsePolicyOrBuilder getDefaultCustomErrorResponsePolicyOrBuilder()
       defaultCustomErrorResponsePolicy specifies how the Load
 Balancer returns error responses when BackendServiceorBackendBucket 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 a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced.
 When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When
 a request that does not match any host in *.example.com such
 as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy
 takes effect.

 When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only
 once all retries are exhausted, thedefaultCustomErrorResponsePolicy 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;

    • hasDefaultRouteAction

      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:
      Whether the defaultRouteAction field is set.

    • getDefaultRouteAction

      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:
      The defaultRouteAction.

    • getDefaultRouteActionOrBuilder

      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;

    • hasDefaultService

      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:
      Whether the defaultService field is set.

    • getDefaultService

      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:
      The defaultService.

    • getDefaultServiceBytes

      com.google.protobuf.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:
      The bytes for defaultService.

    • hasDefaultUrlRedirect

      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:
      Whether the defaultUrlRedirect field is set.

    • getDefaultUrlRedirect

      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:
      The defaultUrlRedirect.

    • getDefaultUrlRedirectOrBuilder

      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;

    • hasDescription

      boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The bytes for description.

    • hasFingerprint

      boolean hasFingerprint()
       Fingerprint of this resource. A hash of the contents stored in this object.
 This field is used in optimistic locking. This field 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:
      Whether the fingerprint field is set.

    • getFingerprint

      String getFingerprint()
       Fingerprint of this resource. A hash of the contents stored in this object.
 This field is used in optimistic locking. This field 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:
      The fingerprint.

    • getFingerprintBytes

      com.google.protobuf.ByteString getFingerprintBytes()
       Fingerprint of this resource. A hash of the contents stored in this object.
 This field is used in optimistic locking. This field 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:
      The bytes for fingerprint.

    • hasHeaderAction

      boolean hasHeaderAction()
       Specifies changes to request and response headers that need to take effect
 for the selected backendService.

 The headerAction specified here take effect afterheaderAction 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:
      Whether the headerAction field is set.

    • getHeaderAction

      HttpHeaderAction getHeaderAction()
       Specifies changes to request and response headers that need to take effect
 for the selected backendService.

 The headerAction specified here take effect afterheaderAction 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:
      The headerAction.

    • getHeaderActionOrBuilder

      HttpHeaderActionOrBuilder getHeaderActionOrBuilder()
       Specifies changes to request and response headers that need to take effect
 for the selected backendService.

 The headerAction specified here take effect afterheaderAction 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;

    • getHostRulesList

      List<HostRule> getHostRulesList()
       The list of host rules to use against the URL.
      repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

    • getHostRules

      HostRule getHostRules(int index)
       The list of host rules to use against the URL.
      repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

    • getHostRulesCount

      int getHostRulesCount()
       The list of host rules to use against the URL.
      repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

    • getHostRulesOrBuilderList

      List<? extends HostRuleOrBuilder> getHostRulesOrBuilderList()
       The list of host rules to use against the URL.
      repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

    • getHostRulesOrBuilder

      HostRuleOrBuilder getHostRulesOrBuilder(int index)
       The list of host rules to use against the URL.
      repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

    • hasId

      boolean hasId()
       [Output Only] The unique identifier for the resource. This identifier is
 defined by the server.
      optional uint64 id = 3355;
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       [Output Only] The unique identifier for the resource. This identifier is
 defined by the server.
      optional uint64 id = 3355;
      Returns:
      The id.

    • hasKind

      boolean hasKind()
       Output only. [Output Only] Type of the resource. Always compute#urlMaps for
 url maps.
      optional string kind = 3292052;
      Returns:
      Whether the kind field is set.

    • getKind

      String getKind()
       Output only. [Output Only] Type of the resource. Always compute#urlMaps for
 url maps.
      optional string kind = 3292052;
      Returns:
      The kind.

    • getKindBytes

      com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] Type of the resource. Always compute#urlMaps for
 url maps.
      optional string kind = 3292052;
      Returns:
      The bytes for kind.

    • hasName

      boolean hasName()
       Name of the resource. Provided by the client when the resource is created.
 The name must be 1-63 characters long, and comply withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must
 be a dash, lowercase letter, or digit, except the last character, which
 cannot be a dash.
      optional string name = 3373707;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Name of the resource. Provided by the client when the resource is created.
 The name must be 1-63 characters long, and comply withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must
 be a dash, lowercase letter, or digit, except the last character, which
 cannot be a dash.
      optional string name = 3373707;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the resource. Provided by the client when the resource is created.
 The name must be 1-63 characters long, and comply withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must
 be a dash, lowercase letter, or digit, except the last character, which
 cannot be a dash.
      optional string name = 3373707;
      Returns:
      The bytes for name.

    • getPathMatchersList

      List<PathMatcher> getPathMatchersList()
       The list of named PathMatchers to use against the URL.
      repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

    • getPathMatchers

      PathMatcher getPathMatchers(int index)
       The list of named PathMatchers to use against the URL.
      repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

    • getPathMatchersCount

      int getPathMatchersCount()
       The list of named PathMatchers to use against the URL.
      repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

    • getPathMatchersOrBuilderList

      List<? extends PathMatcherOrBuilder> getPathMatchersOrBuilderList()
       The list of named PathMatchers to use against the URL.
      repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

    • getPathMatchersOrBuilder

      PathMatcherOrBuilder getPathMatchersOrBuilder(int index)
       The list of named PathMatchers to use against the URL.
      repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

    • hasRegion

      boolean hasRegion()
       Output only. [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:
      Whether the region field is set.

    • getRegion

      String getRegion()
       Output only. [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:
      The region.

    • getRegionBytes

      com.google.protobuf.ByteString getRegionBytes()
       Output only. [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:
      The bytes for region.

    • hasSelfLink

      boolean hasSelfLink()
       [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      Whether the selfLink field is set.

    • getSelfLink

      String getSelfLink()
       [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      The selfLink.

    • getSelfLinkBytes

      com.google.protobuf.ByteString getSelfLinkBytes()
       [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      The bytes for selfLink.

    • getTestsList

      List<UrlMapTest> getTestsList()
       The list of expected URL mapping tests. Request to update theUrlMap 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;

    • getTests

      UrlMapTest getTests(int index)
       The list of expected URL mapping tests. Request to update theUrlMap 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;

    • getTestsCount

      int getTestsCount()
       The list of expected URL mapping tests. Request to update theUrlMap 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;

    • getTestsOrBuilderList

      List<? extends UrlMapTestOrBuilder> getTestsOrBuilderList()
       The list of expected URL mapping tests. Request to update theUrlMap 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;

    • getTestsOrBuilder

      UrlMapTestOrBuilder getTestsOrBuilder(int index)
       The list of expected URL mapping tests. Request to update theUrlMap 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;