UrlMap.Builder (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.UrlMap.Builder

Enclosing class:: UrlMap

public static class UrlMap.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UrlMap.Builder`	`addAllHostRules(List<HostRule> hostRules)` The list of HostRules to use against the URL.
`UrlMap.Builder`	`addAllPathMatchers(List<PathMatcher> pathMatchers)` The list of named PathMatchers to use against the URL.
`UrlMap.Builder`	`addAllTests(List<UrlMapTest> tests)` The list of expected URL mapping tests.
`UrlMap.Builder`	`addHostRules(HostRule hostRules)` The list of HostRules to use against the URL.
`UrlMap.Builder`	`addPathMatchers(PathMatcher pathMatchers)` The list of named PathMatchers to use against the URL.
`UrlMap.Builder`	`addTests(UrlMapTest tests)` The list of expected URL mapping tests.
`UrlMap`	`build()`
`UrlMap.Builder`	`clone()`
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`HttpRouteAction`	`getDefaultRouteAction()` defaultRouteAction takes effect when none of the hostRules match.
`String`	`getDefaultService()` The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match.
`HttpRedirectAction`	`getDefaultUrlRedirect()` When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.
`String`	`getDescription()` An optional description of this resource.
`String`	`getFingerprint()` Fingerprint of this resource.
`HttpHeaderAction`	`getHeaderAction()` Specifies changes to request and response headers that need to take effect for the selected backendService.
`List<HostRule>`	`getHostRulesList()` The list of HostRules to use against the URL.
`String`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` Name of the resource.
`List<PathMatcher>`	`getPathMatchersList()` The list of named PathMatchers to use against the URL.
`String`	`getRegion()` [Output Only] URL of the region where the regional URL map resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`List<UrlMapTest>`	`getTestsList()` The list of expected URL mapping tests.
`UrlMap.Builder`	`mergeFrom(UrlMap other)`
`UrlMap.Builder`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`UrlMap.Builder`	`setDefaultRouteAction(HttpRouteAction defaultRouteAction)` defaultRouteAction takes effect when none of the hostRules match.
`UrlMap.Builder`	`setDefaultService(String defaultService)` The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match.
`UrlMap.Builder`	`setDefaultUrlRedirect(HttpRedirectAction defaultUrlRedirect)` When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.
`UrlMap.Builder`	`setDescription(String description)` An optional description of this resource.
`UrlMap.Builder`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`UrlMap.Builder`	`setHeaderAction(HttpHeaderAction headerAction)` Specifies changes to request and response headers that need to take effect for the selected backendService.
`UrlMap.Builder`	`setId(String id)` [Output Only] The unique identifier for the resource.
`UrlMap.Builder`	`setKind(String kind)` [Output Only] Type of the resource.
`UrlMap.Builder`	`setName(String name)` Name of the resource.
`UrlMap.Builder`	`setRegion(String region)` [Output Only] URL of the region where the regional URL map resides.
`UrlMap.Builder`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - mergeFrom
```
public UrlMap.Builder mergeFrom(UrlMap other)
```
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - setCreationTimestamp
```
public UrlMap.Builder setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDefaultRouteAction
```
public HttpRouteAction getDefaultRouteAction()
```
    defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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.
  - setDefaultRouteAction
```
public UrlMap.Builder setDefaultRouteAction(HttpRouteAction defaultRouteAction)
```
    defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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.
  - 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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.
  - setDefaultService
```
public UrlMap.Builder setDefaultService(String defaultService)
```
    The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to 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.
  - getDefaultUrlRedirect
```
public 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.
  - setDefaultUrlRedirect
```
public UrlMap.Builder setDefaultUrlRedirect(HttpRedirectAction defaultUrlRedirect)
```
    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.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - setDescription
```
public UrlMap.Builder setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
  - 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 will be 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.
  - setFingerprint
```
public UrlMap.Builder setFingerprint(String fingerprint)
```
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a 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.
  - 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.
  - setHeaderAction
```
public UrlMap.Builder setHeaderAction(HttpHeaderAction headerAction)
```
    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.
  - getHostRulesList
```
public List<HostRule> getHostRulesList()
```
    The list of HostRules to use against the URL.
  - addAllHostRules
```
public UrlMap.Builder addAllHostRules(List<HostRule> hostRules)
```
    The list of HostRules to use against the URL.
  - addHostRules
```
public UrlMap.Builder addHostRules(HostRule hostRules)
```
    The list of HostRules to use against the URL.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - setId
```
public UrlMap.Builder setId(String id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#urlMaps for url maps.
  - setKind
```
public UrlMap.Builder setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#urlMaps for url maps.
  - 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]([-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.
  - setName
```
public UrlMap.Builder setName(String name)
```
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  - getPathMatchersList
```
public List<PathMatcher> getPathMatchersList()
```
    The list of named PathMatchers to use against the URL.
  - addAllPathMatchers
```
public UrlMap.Builder addAllPathMatchers(List<PathMatcher> pathMatchers)
```
    The list of named PathMatchers to use against the URL.
  - addPathMatchers
```
public UrlMap.Builder addPathMatchers(PathMatcher pathMatchers)
```
    The list of named PathMatchers to use against the URL.
  - 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.
  - setRegion
```
public UrlMap.Builder setRegion(String region)
```
    [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.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - setSelfLink
```
public UrlMap.Builder setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
  - getTestsList
```
public List<UrlMapTest> getTestsList()
```
    The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.
  - addAllTests
```
public UrlMap.Builder addAllTests(List<UrlMapTest> tests)
```
    The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.
  - addTests
```
public UrlMap.Builder addTests(UrlMapTest tests)
```
    The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.
  - build
```
public UrlMap build()
```
  - clone
```
public UrlMap.Builder clone()
```
    Overrides:
    
    clone in class Object

Class UrlMap.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getCreationTimestamp

setCreationTimestamp

getDefaultRouteAction

setDefaultRouteAction

getDefaultService

setDefaultService

getDefaultUrlRedirect

setDefaultUrlRedirect

getDescription

setDescription

getFingerprint

setFingerprint

getHeaderAction

setHeaderAction

getHostRulesList

addAllHostRules

addHostRules

getId

setId

getKind

setKind

getName

setName

getPathMatchersList

addAllPathMatchers

addPathMatchers

getRegion

setRegion

getSelfLink

setSelfLink

getTestsList

addAllTests

addTests

build

clone