Compute.Networks.ListPeeringRoutes (Compute Engine API v1 (Rev. 235) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.compute.ComputeRequest<ExchangedPeeringRoutesList>
        
        com.google.api.services.compute.Compute.Networks.ListPeeringRoutes

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Compute.Networks
```
public class Compute.Networks.ListPeeringRoutes
extends ComputeRequest<ExchangedPeeringRoutesList>
```

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ListPeeringRoutes(java.lang.String project, java.lang.String network)` Lists the peering routes exchanged over peering connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getDirection()` The direction of the exchanged routes.
`java.lang.String`	`getFilter()` A filter expression that filters resources listed in the response.
`java.lang.Long`	`getMaxResults()` The maximum number of results per page that should be returned.
`java.lang.String`	`getNetwork()` Name of the network for this request.
`java.lang.String`	`getOrderBy()` Sorts list results by a certain order.
`java.lang.String`	`getPageToken()` Specifies a page token to use.
`java.lang.String`	`getPeeringName()` The response will show routes exchanged over the given peering connection.
`java.lang.String`	`getProject()` Project ID for this request.
`java.lang.String`	`getRegion()` The region of the request.
`Compute.Networks.ListPeeringRoutes`	`set(java.lang.String parameterName, java.lang.Object value)`
`Compute.Networks.ListPeeringRoutes`	`setAlt(java.lang.String alt)` Data format for the response.
`Compute.Networks.ListPeeringRoutes`	`setDirection(java.lang.String direction)` The direction of the exchanged routes.
`Compute.Networks.ListPeeringRoutes`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Compute.Networks.ListPeeringRoutes`	`setFilter(java.lang.String filter)` A filter expression that filters resources listed in the response.
`Compute.Networks.ListPeeringRoutes`	`setKey(java.lang.String key)` API key.
`Compute.Networks.ListPeeringRoutes`	`setMaxResults(java.lang.Long maxResults)` The maximum number of results per page that should be returned.
`Compute.Networks.ListPeeringRoutes`	`setNetwork(java.lang.String network)` Name of the network for this request.
`Compute.Networks.ListPeeringRoutes`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Compute.Networks.ListPeeringRoutes`	`setOrderBy(java.lang.String orderBy)` Sorts list results by a certain order.
`Compute.Networks.ListPeeringRoutes`	`setPageToken(java.lang.String pageToken)` Specifies a page token to use.
`Compute.Networks.ListPeeringRoutes`	`setPeeringName(java.lang.String peeringName)` The response will show routes exchanged over the given peering connection.
`Compute.Networks.ListPeeringRoutes`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Compute.Networks.ListPeeringRoutes`	`setProject(java.lang.String project)` Project ID for this request.
`Compute.Networks.ListPeeringRoutes`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Compute.Networks.ListPeeringRoutes`	`setRegion(java.lang.String region)` The region of the request.
`Compute.Networks.ListPeeringRoutes`	`setUserIp(java.lang.String userIp)` Deprecated.

Methods inherited from class com.google.api.services.compute.ComputeRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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
  - ListPeeringRoutes
```
protected ListPeeringRoutes(java.lang.String project,
                            java.lang.String network)
```
    Lists the peering routes exchanged over peering connection. Create a request for the method "networks.listPeeringRoutes". This request holds the parameters needed by the the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    ListPeeringRoutes#initialize(com.google.api.client.googleapis.services.AbstractGoogl eClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    project - Project ID for this request.
    
    network - Name of the network for this request.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ExchangedPeeringRoutesList>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ExchangedPeeringRoutesList>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Compute.Networks.ListPeeringRoutes setAlt(java.lang.String alt)
```
    Description copied from class: ComputeRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class ComputeRequest<ExchangedPeeringRoutesList>
  - setFields
```
public Compute.Networks.ListPeeringRoutes setFields(java.lang.String fields)
```
    Description copied from class: ComputeRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ComputeRequest<ExchangedPeeringRoutesList>
  - setKey
```
public Compute.Networks.ListPeeringRoutes setKey(java.lang.String key)
```
    Description copied from class: ComputeRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class ComputeRequest<ExchangedPeeringRoutesList>
  - setOauthToken
```
public Compute.Networks.ListPeeringRoutes setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: ComputeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ComputeRequest<ExchangedPeeringRoutesList>
  - setPrettyPrint
```
public Compute.Networks.ListPeeringRoutes setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: ComputeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ComputeRequest<ExchangedPeeringRoutesList>
  - setQuotaUser
```
public Compute.Networks.ListPeeringRoutes setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: ComputeRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class ComputeRequest<ExchangedPeeringRoutesList>
  - setUserIp
```
public Compute.Networks.ListPeeringRoutes setUserIp(java.lang.String userIp)
```
    Description copied from class: ComputeRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class ComputeRequest<ExchangedPeeringRoutesList>
  - getProject
```
public java.lang.String getProject()
```
    Project ID for this request.
  - setProject
```
public Compute.Networks.ListPeeringRoutes setProject(java.lang.String project)
```
    Project ID for this request.
  - getNetwork
```
public java.lang.String getNetwork()
```
    Name of the network for this request.
  - setNetwork
```
public Compute.Networks.ListPeeringRoutes setNetwork(java.lang.String network)
```
    Name of the network for this request.
  - getDirection
```
public java.lang.String getDirection()
```
    The direction of the exchanged routes.
  - setDirection
```
public Compute.Networks.ListPeeringRoutes setDirection(java.lang.String direction)
```
    The direction of the exchanged routes.
  - getFilter
```
public java.lang.String getFilter()
```
    A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
  - setFilter
```
public Compute.Networks.ListPeeringRoutes setFilter(java.lang.String filter)
```
    A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
  - getMaxResults
```
public java.lang.Long getMaxResults()
```
    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) [default: 500] [minimum: 0]
  - setMaxResults
```
public Compute.Networks.ListPeeringRoutes setMaxResults(java.lang.Long maxResults)
```
    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
  - setOrderBy
```
public Compute.Networks.ListPeeringRoutes setOrderBy(java.lang.String orderBy)
```
    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
  - getPageToken
```
public java.lang.String getPageToken()
```
    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  - setPageToken
```
public Compute.Networks.ListPeeringRoutes setPageToken(java.lang.String pageToken)
```
    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
  - getPeeringName
```
public java.lang.String getPeeringName()
```
    The response will show routes exchanged over the given peering connection.
  - setPeeringName
```
public Compute.Networks.ListPeeringRoutes setPeeringName(java.lang.String peeringName)
```
    The response will show routes exchanged over the given peering connection.
  - getRegion
```
public java.lang.String getRegion()
```
    The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.
  - setRegion
```
public Compute.Networks.ListPeeringRoutes setRegion(java.lang.String region)
```
    The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.
  - set
```
public Compute.Networks.ListPeeringRoutes set(java.lang.String parameterName,
                                              java.lang.Object value)
```
    Overrides:
    
    set in class ComputeRequest<ExchangedPeeringRoutesList>

Compute Engine API v1 (revision 235)

Class Compute.Networks.ListPeeringRoutes

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.compute.ComputeRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ListPeeringRoutes

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getProject

setProject

getNetwork

setNetwork

getDirection

setDirection

getFilter

setFilter

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getPeeringName

setPeeringName

getRegion

setRegion

set