com.google.api.services.compute

Class Compute.Routers.ListBgpRoutes

java.lang.Object

java.util.AbstractMap<String,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<RoutersListBgpRoutes>

com.google.api.services.compute.Compute.Routers.ListBgpRoutes

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Routers

public class Compute.Routers.ListBgpRoutes
extends ComputeRequest<RoutersListBgpRoutes>

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>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListBgpRoutes(String project, String region, String router) Retrieves a list of router bgp routes available to the specified project.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getAddressFamily() ( Required) limit results to this address family (either IPv4 or IPv6) [default: ( UNSPECIFIED_IP_VERSION] (
String	getDestinationPrefix() Limit results to destinations that are subnets of this CIDR range
String	getFilter() A filter expression that filters resources listed in the response.
Long	getMaxResults() The maximum number of results per page that should be returned.
String	getOrderBy() Sorts list results by a certain order.
String	getPageToken() Specifies a page token to use.
String	getPeer() ( Required) limit results to the BGP peer with the given name.
Boolean	getPolicyApplied() When true, the method returns post-policy routes.
String	getProject() Project ID for this request.
String	getRegion() Name of the region for this request.
Boolean	getReturnPartialSuccess() Opt-in for partial success behavior which provides partial results in case of failure.
String	getRouter() Name or id of the resource for this request.
String	getRouteType() ( Required) limit results to this type of route (either LEARNED or ADVERTISED) [default: ( UNSPECIFIED_ROUTE_TYPE] (
boolean	isPolicyApplied() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Compute.Routers.ListBgpRoutes	set(String parameterName, Object value)
Compute.Routers.ListBgpRoutes	set$Xgafv(String $Xgafv) V1 error format.
Compute.Routers.ListBgpRoutes	setAccessToken(String accessToken) OAuth access token.
Compute.Routers.ListBgpRoutes	setAddressFamily(String addressFamily) (Required) limit results to this address family (either IPv4 or IPv6)
Compute.Routers.ListBgpRoutes	setAlt(String alt) Data format for response.
Compute.Routers.ListBgpRoutes	setCallback(String callback) JSONP
Compute.Routers.ListBgpRoutes	setDestinationPrefix(String destinationPrefix) Limit results to destinations that are subnets of this CIDR range
Compute.Routers.ListBgpRoutes	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.Routers.ListBgpRoutes	setFilter(String filter) A filter expression that filters resources listed in the response.
Compute.Routers.ListBgpRoutes	setKey(String key) API key.
Compute.Routers.ListBgpRoutes	setMaxResults(Long maxResults) The maximum number of results per page that should be returned.
Compute.Routers.ListBgpRoutes	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.Routers.ListBgpRoutes	setOrderBy(String orderBy) Sorts list results by a certain order.
Compute.Routers.ListBgpRoutes	setPageToken(String pageToken) Specifies a page token to use.
Compute.Routers.ListBgpRoutes	setPeer(String peer) (Required) limit results to the BGP peer with the given name.
Compute.Routers.ListBgpRoutes	setPolicyApplied(Boolean policyApplied) When true, the method returns post-policy routes.
Compute.Routers.ListBgpRoutes	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Routers.ListBgpRoutes	setProject(String project) Project ID for this request.
Compute.Routers.ListBgpRoutes	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.Routers.ListBgpRoutes	setRegion(String region) Name of the region for this request.
Compute.Routers.ListBgpRoutes	setReturnPartialSuccess(Boolean returnPartialSuccess) Opt-in for partial success behavior which provides partial results in case of failure.
Compute.Routers.ListBgpRoutes	setRouter(String router) Name or id of the resource for this request.
Compute.Routers.ListBgpRoutes	setRouteType(String routeType) (Required) limit results to this type of route (either LEARNED or ADVERTISED)
Compute.Routers.ListBgpRoutes	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.Routers.ListBgpRoutes	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.Routers.ListBgpRoutes	setUserIp(String userIp) Legacy name for parameter that has been superseded by `quotaUser`.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

ListBgpRoutes

protected ListBgpRoutes(String project,
                        String region,
                        String router)

Retrieves a list of router bgp routes available to the specified project. Create a request for the method "routers.listBgpRoutes". 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.

ListBgpRoutes#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientR equest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name or id of the resource for this request. Name should conform to RFC1035.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RoutersListBgpRoutes>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RoutersListBgpRoutes>

Throws:

IOException

set$Xgafv

public Compute.Routers.ListBgpRoutes set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<RoutersListBgpRoutes>

setAccessToken

public Compute.Routers.ListBgpRoutes setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<RoutersListBgpRoutes>

setAlt

public Compute.Routers.ListBgpRoutes setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<RoutersListBgpRoutes>

setCallback

public Compute.Routers.ListBgpRoutes setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<RoutersListBgpRoutes>

setFields

public Compute.Routers.ListBgpRoutes setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<RoutersListBgpRoutes>

setKey

public Compute.Routers.ListBgpRoutes setKey(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<RoutersListBgpRoutes>

setOauthToken

public Compute.Routers.ListBgpRoutes setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<RoutersListBgpRoutes>

setPrettyPrint

public Compute.Routers.ListBgpRoutes setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<RoutersListBgpRoutes>

setQuotaUser

public Compute.Routers.ListBgpRoutes setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ComputeRequest<RoutersListBgpRoutes>

setUploadType

public Compute.Routers.ListBgpRoutes setUploadType(String uploadType)

Description copied from class: ComputeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ComputeRequest<RoutersListBgpRoutes>

setUploadProtocol

public Compute.Routers.ListBgpRoutes setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ComputeRequest<RoutersListBgpRoutes>

setUserIp

public Compute.Routers.ListBgpRoutes setUserIp(String userIp)

Description copied from class: ComputeRequest

Legacy name for parameter that has been superseded by `quotaUser`.

Overrides:

setUserIp in class ComputeRequest<RoutersListBgpRoutes>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Routers.ListBgpRoutes setProject(String project)

Project ID for this request.

getRegion

public String getRegion()

Name of the region for this request.

setRegion

public Compute.Routers.ListBgpRoutes setRegion(String region)

Name of the region for this request.

getRouter

public String getRouter()

Name or id of the resource for this request. Name should conform to RFC1035.

setRouter

public Compute.Routers.ListBgpRoutes setRouter(String router)

Name or id of the resource for this request. Name should conform to RFC1035.

getAddressFamily

public String getAddressFamily()

( Required) limit results to this address family (either IPv4 or IPv6) [default: ( UNSPECIFIED_IP_VERSION] (

setAddressFamily

public Compute.Routers.ListBgpRoutes setAddressFamily(String addressFamily)

(Required) limit results to this address family (either IPv4 or IPv6)

getDestinationPrefix

public String getDestinationPrefix()

Limit results to destinations that are subnets of this CIDR range

setDestinationPrefix

public Compute.Routers.ListBgpRoutes setDestinationPrefix(String destinationPrefix)

Limit results to destinations that are subnets of this CIDR range

getFilter

public String getFilter()

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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 onresource 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

setFilter

public Compute.Routers.ListBgpRoutes setFilter(String filter)

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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 onresource 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

getMaxResults

public 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.Routers.ListBgpRoutes setMaxResults(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 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.Routers.ListBgpRoutes setOrderBy(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 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.Routers.ListBgpRoutes setPageToken(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.

getPeer

public String getPeer()

( Required) limit results to the BGP peer with the given name. Name should conform to RFC1035. (

setPeer

public Compute.Routers.ListBgpRoutes setPeer(String peer)

(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.

getPolicyApplied

public Boolean getPolicyApplied()

When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes. [default: true]

setPolicyApplied

public Compute.Routers.ListBgpRoutes setPolicyApplied(Boolean policyApplied)

When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.

isPolicyApplied

public boolean isPolicyApplied()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.

getReturnPartialSuccess

public Boolean getReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

setReturnPartialSuccess

public Compute.Routers.ListBgpRoutes setReturnPartialSuccess(Boolean returnPartialSuccess)

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

getRouteType

public String getRouteType()

( Required) limit results to this type of route (either LEARNED or ADVERTISED) [default: ( UNSPECIFIED_ROUTE_TYPE] (

setRouteType

public Compute.Routers.ListBgpRoutes setRouteType(String routeType)

(Required) limit results to this type of route (either LEARNED or ADVERTISED)

set

public Compute.Routers.ListBgpRoutes set(String parameterName,
                                         Object value)

Overrides:

set in class ComputeRequest<RoutersListBgpRoutes>