UrlMap (Compute Engine API v1 (Rev. 103) 1.21.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.UrlMap

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class UrlMap
extends com.google.api.client.json.GenericJson
```
A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

UrlMap()

Constructors
Constructor and Description
`UrlMap()`

Method Summary

Methods
Modifier and Type	Method and Description
`UrlMap`	`clone()`
`byte[]`	`decodeFingerprint()` Fingerprint of this resource.
`UrlMap`	`encodeFingerprint(byte[] fingerprint)` Fingerprint of this resource.
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getDefaultService()` The URL of the BackendService resource if none of the hostRules match.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.String`	`getFingerprint()` Fingerprint of this resource.
`java.util.List<HostRule>`	`getHostRules()` The list of HostRules to use against the URL.
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.lang.String`	`getKind()` [Output Only] Type of the resource.
`java.lang.String`	`getName()` Name of the resource.
`java.util.List<PathMatcher>`	`getPathMatchers()` The list of named PathMatchers to use against the URL.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`java.util.List<UrlMapTest>`	`getTests()` The list of expected URL mappings.
`UrlMap`	`set(java.lang.String fieldName, java.lang.Object value)`
`UrlMap`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`UrlMap`	`setDefaultService(java.lang.String defaultService)` The URL of the BackendService resource if none of the hostRules match.
`UrlMap`	`setDescription(java.lang.String description)` An optional description of this resource.
`UrlMap`	`setFingerprint(java.lang.String fingerprint)` Fingerprint of this resource.
`UrlMap`	`setHostRules(java.util.List<HostRule> hostRules)` The list of HostRules to use against the URL.
`UrlMap`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`UrlMap`	`setKind(java.lang.String kind)` [Output Only] Type of the resource.
`UrlMap`	`setName(java.lang.String name)` Name of the resource.
`UrlMap`	`setPathMatchers(java.util.List<PathMatcher> pathMatchers)` The list of named PathMatchers to use against the URL.
`UrlMap`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for the resource.
`UrlMap`	`setTests(java.util.List<UrlMapTest> tests)` The list of expected URL mappings.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

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

- Constructor Detail
  - UrlMap
```
public UrlMap()
```
- Method Detail
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    value or null for none
  - setCreationTimestamp
```
public UrlMap setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    creationTimestamp - creationTimestamp or null for none
  - getDefaultService
```
public java.lang.String getDefaultService()
```
    The URL of the BackendService resource if none of the hostRules match.
    
    Returns:
    value or null for none
  - setDefaultService
```
public UrlMap setDefaultService(java.lang.String defaultService)
```
    The URL of the BackendService resource if none of the hostRules match.
    
    Parameters:
    defaultService - defaultService or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    value or null for none
  - setDescription
```
public UrlMap setDescription(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    description - description or null for none
  - getFingerprint
```
public java.lang.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.
    
    Returns:
    value or null for none
    See Also:
    decodeFingerprint()
  - decodeFingerprint
```
public byte[] decodeFingerprint()
```
    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.
    
    Returns:
    Base64 decoded value or null for none
    Since:
    
    1.14
    
    See Also:
    getFingerprint()
  - setFingerprint
```
public UrlMap setFingerprint(java.lang.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.
    
    Parameters:
    fingerprint - fingerprint or null for none
    See Also:
    #encodeFingerprint()
  - encodeFingerprint
```
public UrlMap encodeFingerprint(byte[] 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.
    
    Since:
    
    1.14
    
    See Also:
    The value is encoded Base64 or {@code null} for none.
  - getHostRules
```
public java.util.List<HostRule> getHostRules()
```
    The list of HostRules to use against the URL.
    
    Returns:
    value or null for none
  - setHostRules
```
public UrlMap setHostRules(java.util.List<HostRule> hostRules)
```
    The list of HostRules to use against the URL.
    
    Parameters:
    hostRules - hostRules or null for none
  - getId
```
public java.math.BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    value or null for none
  - setId
```
public UrlMap setId(java.math.BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    
    Returns:
    value or null for none
  - setKind
```
public UrlMap setKind(java.lang.String kind)
```
    [Output Only] Type of the resource. Always compute#urlMaps for url maps.
    
    Parameters:
    kind - kind or null for none
  - getName
```
public java.lang.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.
    
    Returns:
    value or null for none
  - setName
```
public UrlMap setName(java.lang.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.
    
    Parameters:
    name - name or null for none
  - getPathMatchers
```
public java.util.List<PathMatcher> getPathMatchers()
```
    The list of named PathMatchers to use against the URL.
    
    Returns:
    value or null for none
  - setPathMatchers
```
public UrlMap setPathMatchers(java.util.List<PathMatcher> pathMatchers)
```
    The list of named PathMatchers to use against the URL.
    
    Parameters:
    pathMatchers - pathMatchers or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    value or null for none
  - setSelfLink
```
public UrlMap setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    selfLink - selfLink or null for none
  - getTests
```
public java.util.List<UrlMapTest> getTests()
```
    The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
    
    Returns:
    value or null for none
  - setTests
```
public UrlMap setTests(java.util.List<UrlMapTest> tests)
```
    The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
    
    Parameters:
    tests - tests or null for none
  - set
```
public UrlMap set(java.lang.String fieldName,
         java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public UrlMap clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 103)

Class UrlMap

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

UrlMap

Method Detail

getCreationTimestamp

setCreationTimestamp

getDefaultService

setDefaultService

getDescription

setDescription

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getHostRules

setHostRules

getId

setId

getKind

setKind

getName

setName

getPathMatchers

setPathMatchers

getSelfLink

setSelfLink

getTests

setTests

set

clone