target.apidocs.com.google.api.services.compute.model.RoutePolicy.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

The newest version!







RoutePolicy (Compute Engine API v1-rev20250320-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class RoutePolicy



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.RoutePolicy













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class RoutePolicy
extends com.google.api.client.json.GenericJson
Model definition for RoutePolicy.

  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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


RoutePolicy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


RoutePolicy
clone() 


byte[]
decodeFingerprint()
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking.



RoutePolicy
encodeFingerprint(byte[] fingerprint)
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking.



String
getDescription()
An optional description of route policy.



String
getFingerprint()
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking.



String
getName()
Route Policy name, which must be a resource ID segment and unique within all the router's Route
 Policies.



List<RoutePolicyPolicyTerm>
getTerms()
List of terms (the order in the list is not important, they are evaluated in order of
 priority).



String
getType() 


RoutePolicy
set(String fieldName,
   Object value) 


RoutePolicy
setDescription(String description)
An optional description of route policy.



RoutePolicy
setFingerprint(String fingerprint)
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking.



RoutePolicy
setName(String name)
Route Policy name, which must be a resource ID segment and unique within all the router's Route
 Policies.



RoutePolicy
setTerms(List<RoutePolicyPolicyTerm> terms)
List of terms (the order in the list is not important, they are evaluated in order of
 priority).



RoutePolicy
setType(String type) 






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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





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





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





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





RoutePolicy
public RoutePolicy()









Method Detail





getDescription
public String getDescription()
An optional description of route policy.

Returns:
value or null for none








setDescription
public RoutePolicy setDescription(String description)
An optional description of route policy.

Parameters:
description - description or null for none








getFingerprint
public String getFingerprint()
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update Route Policy. You must always
 provide an up-to-date fingerprint hash in order to update or change labels. To see the latest
 fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.

Returns:
value or null for none
See Also:
decodeFingerprint()








decodeFingerprint
public byte[] decodeFingerprint()
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update Route Policy. You must always
 provide an up-to-date fingerprint hash in order to update or change labels. To see the latest
 fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getFingerprint()








setFingerprint
public RoutePolicy setFingerprint(String fingerprint)
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update Route Policy. You must always
 provide an up-to-date fingerprint hash in order to update or change labels. To see the latest
 fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.

Parameters:
fingerprint - fingerprint or null for none
See Also:
#encodeFingerprint()








encodeFingerprint
public RoutePolicy encodeFingerprint(byte[] fingerprint)
A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of
 the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute
 Engine and changes after every request to modify or update Route Policy. You must always
 provide an up-to-date fingerprint hash in order to update or change labels. To see the latest
 fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getName
public String getName()
Route Policy name, which must be a resource ID segment and unique within all the router's Route
 Policies. Name should conform to RFC1035.

Returns:
value or null for none








setName
public RoutePolicy setName(String name)
Route Policy name, which must be a resource ID segment and unique within all the router's Route
 Policies. Name should conform to RFC1035.

Parameters:
name - name or null for none








getTerms
public List<RoutePolicyPolicyTerm> getTerms()
List of terms (the order in the list is not important, they are evaluated in order of
 priority). Order of policies is not retained and might change when getting policy later.

Returns:
value or null for none








setTerms
public RoutePolicy setTerms(List<RoutePolicyPolicyTerm> terms)
List of terms (the order in the list is not important, they are evaluated in order of
 priority). Order of policies is not retained and might change when getting policy later.

Parameters:
terms - terms or null for none








getType
public String getType()

Returns:
value or null for none








setType
public RoutePolicy setType(String type)

Parameters:
type - type or null for none








set
public RoutePolicy set(String fieldName,
                       Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public RoutePolicy clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`RoutePolicy`	`clone()`
`byte[]`	`decodeFingerprint()` A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking.
`RoutePolicy`	`encodeFingerprint(byte[] fingerprint)` A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking.
`String`	`getDescription()` An optional description of route policy.
`String`	`getFingerprint()` A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking.
`String`	`getName()` Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies.
`List<RoutePolicyPolicyTerm>`	`getTerms()` List of terms (the order in the list is not important, they are evaluated in order of priority).
`String`	`getType()`
`RoutePolicy`	`set(String fieldName, Object value)`
`RoutePolicy`	`setDescription(String description)` An optional description of route policy.
`RoutePolicy`	`setFingerprint(String fingerprint)` A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking.
`RoutePolicy`	`setName(String name)` Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies.
`RoutePolicy`	`setTerms(List<RoutePolicyPolicyTerm> terms)` List of terms (the order in the list is not important, they are evaluated in order of priority).
`RoutePolicy`	`setType(String type)`