com.google.cloud.compute.v1

Interface ListBgpRoutesRoutersRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListBgpRoutesRoutersRequest, ListBgpRoutesRoutersRequest.Builder

public interface ListBgpRoutesRoutersRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAddressFamily() (Required) limit results to this address family (either IPv4 or IPv6) Check the AddressFamily enum for the list of possible values.
com.google.protobuf.ByteString	getAddressFamilyBytes() (Required) limit results to this address family (either IPv4 or IPv6) Check the AddressFamily enum for the list of possible values.
String	getDestinationPrefix() Limit results to destinations that are subnets of this CIDR range optional string destination_prefix = 263872483;
com.google.protobuf.ByteString	getDestinationPrefixBytes() Limit results to destinations that are subnets of this CIDR range optional string destination_prefix = 263872483;
String	getFilter() A filter expression that filters resources listed in the response.
com.google.protobuf.ByteString	getFilterBytes() A filter expression that filters resources listed in the response.
int	getMaxResults() The maximum number of results per page that should be returned.
String	getOrderBy() Sorts list results by a certain order.
com.google.protobuf.ByteString	getOrderByBytes() Sorts list results by a certain order.
String	getPageToken() Specifies a page token to use.
com.google.protobuf.ByteString	getPageTokenBytes() Specifies a page token to use.
String	getPeer() (Required) limit results to the BGP peer with the given name.
com.google.protobuf.ByteString	getPeerBytes() (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.
com.google.protobuf.ByteString	getProjectBytes() Project ID for this request.
String	getRegion() Name of the region for this request.
com.google.protobuf.ByteString	getRegionBytes() 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.
com.google.protobuf.ByteString	getRouterBytes() Name or id of the resource for this request.
String	getRouteType() (Required) limit results to this type of route (either LEARNED or ADVERTISED) Check the RouteType enum for the list of possible values.
com.google.protobuf.ByteString	getRouteTypeBytes() (Required) limit results to this type of route (either LEARNED or ADVERTISED) Check the RouteType enum for the list of possible values.
boolean	hasAddressFamily() (Required) limit results to this address family (either IPv4 or IPv6) Check the AddressFamily enum for the list of possible values.
boolean	hasDestinationPrefix() Limit results to destinations that are subnets of this CIDR range optional string destination_prefix = 263872483;
boolean	hasFilter() A filter expression that filters resources listed in the response.
boolean	hasMaxResults() The maximum number of results per page that should be returned.
boolean	hasOrderBy() Sorts list results by a certain order.
boolean	hasPageToken() Specifies a page token to use.
boolean	hasPeer() (Required) limit results to the BGP peer with the given name.
boolean	hasPolicyApplied() When true, the method returns post-policy routes.
boolean	hasReturnPartialSuccess() Opt-in for partial success behavior which provides partial results in case of failure.
boolean	hasRouteType() (Required) limit results to this type of route (either LEARNED or ADVERTISED) Check the RouteType enum for the list of possible values.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasAddressFamily

boolean hasAddressFamily()

 (Required) limit results to this address family (either IPv4 or IPv6)
 Check the AddressFamily enum for the list of possible values.
 

optional string address_family = 173744655;

Returns:

Whether the addressFamily field is set.

getAddressFamily

String getAddressFamily()

 (Required) limit results to this address family (either IPv4 or IPv6)
 Check the AddressFamily enum for the list of possible values.
 

optional string address_family = 173744655;

Returns:

The addressFamily.

getAddressFamilyBytes

com.google.protobuf.ByteString getAddressFamilyBytes()

 (Required) limit results to this address family (either IPv4 or IPv6)
 Check the AddressFamily enum for the list of possible values.
 

optional string address_family = 173744655;

Returns:

The bytes for addressFamily.

hasDestinationPrefix

boolean hasDestinationPrefix()

 Limit results to destinations that are subnets of this CIDR range
 

optional string destination_prefix = 263872483;

Returns:

Whether the destinationPrefix field is set.

getDestinationPrefix

String getDestinationPrefix()

 Limit results to destinations that are subnets of this CIDR range
 

optional string destination_prefix = 263872483;

Returns:

The destinationPrefix.

getDestinationPrefixBytes

com.google.protobuf.ByteString getDestinationPrefixBytes()

 Limit results to destinations that are subnets of this CIDR range
 

optional string destination_prefix = 263872483;

Returns:

The bytes for destinationPrefix.

hasFilter

boolean hasFilter()

 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 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) ``` 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 Google RE2 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.
 

optional string filter = 336120696;

Returns:

Whether the filter field is set.

getFilter

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 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) ``` 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 Google RE2 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.
 

optional string filter = 336120696;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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 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) ``` 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 Google RE2 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.
 

optional string filter = 336120696;

Returns:

The bytes for filter.

hasMaxResults

boolean hasMaxResults()

 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`)
 

optional uint32 max_results = 54715419;

Returns:

Whether the maxResults field is set.

getMaxResults

int 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`)
 

optional uint32 max_results = 54715419;

Returns:

The maxResults.

hasOrderBy

boolean hasOrderBy()

 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.
 

optional string order_by = 160562920;

Returns:

Whether the orderBy field is set.

getOrderBy

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.
 

optional string order_by = 160562920;

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 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.
 

optional string order_by = 160562920;

Returns:

The bytes for orderBy.

hasPageToken

boolean hasPageToken()

 Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
 

optional string page_token = 19994697;

Returns:

Whether the pageToken field is set.

getPageToken

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.
 

optional string page_token = 19994697;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
 

optional string page_token = 19994697;

Returns:

The bytes for pageToken.

hasPeer

boolean hasPeer()

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

optional string peer = 3436898;

Returns:

Whether the peer field is set.

getPeer

String getPeer()

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

optional string peer = 3436898;

Returns:

The peer.

getPeerBytes

com.google.protobuf.ByteString getPeerBytes()

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

optional string peer = 3436898;

Returns:

The bytes for peer.

hasPolicyApplied

boolean hasPolicyApplied()

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

optional bool policy_applied = 379464304;

Returns:

Whether the policyApplied field is set.

getPolicyApplied

boolean getPolicyApplied()

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

optional bool policy_applied = 379464304;

Returns:

The policyApplied.

getProject

String getProject()

 Project ID for this request.
 

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Returns:

The project.

getProjectBytes

com.google.protobuf.ByteString getProjectBytes()

 Project ID for this request.
 

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for project.

getRegion

String getRegion()

 Name of the region for this request.
 

string region = 138946292 [(.google.api.field_behavior) = REQUIRED];

Returns:

The region.

getRegionBytes

com.google.protobuf.ByteString getRegionBytes()

 Name of the region for this request.
 

string region = 138946292 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for region.

hasReturnPartialSuccess

boolean hasReturnPartialSuccess()

 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.
 

optional bool return_partial_success = 517198390;

Returns:

Whether the returnPartialSuccess field is set.

getReturnPartialSuccess

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.
 

optional bool return_partial_success = 517198390;

Returns:

The returnPartialSuccess.

hasRouteType

boolean hasRouteType()

 (Required) limit results to this type of route (either LEARNED or ADVERTISED)
 Check the RouteType enum for the list of possible values.
 

optional string route_type = 375888752;

Returns:

Whether the routeType field is set.

getRouteType

String getRouteType()

 (Required) limit results to this type of route (either LEARNED or ADVERTISED)
 Check the RouteType enum for the list of possible values.
 

optional string route_type = 375888752;

Returns:

The routeType.

getRouteTypeBytes

com.google.protobuf.ByteString getRouteTypeBytes()

 (Required) limit results to this type of route (either LEARNED or ADVERTISED)
 Check the RouteType enum for the list of possible values.
 

optional string route_type = 375888752;

Returns:

The bytes for routeType.

getRouter

String getRouter()

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

string router = 148608841 [(.google.api.field_behavior) = REQUIRED];

Returns:

The router.

getRouterBytes

com.google.protobuf.ByteString getRouterBytes()

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

string router = 148608841 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for router.