public final class ListBgpRoutesRoutersRequest extends GeneratedMessageV3 implements ListBgpRoutesRoutersRequestOrBuilder
A request message for Routers.ListBgpRoutes. See the method description for details.
Protobuf type google.cloud.compute.v1.ListBgpRoutesRoutersRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ADDRESS_FAMILY_FIELD_NUMBER
public static final int ADDRESS_FAMILY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESTINATION_PREFIX_FIELD_NUMBER
public static final int DESTINATION_PREFIX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_RESULTS_FIELD_NUMBER
public static final int MAX_RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PEER_FIELD_NUMBER
public static final int PEER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
POLICY_APPLIED_FIELD_NUMBER
public static final int POLICY_APPLIED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROJECT_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RETURN_PARTIAL_SUCCESS_FIELD_NUMBER
public static final int RETURN_PARTIAL_SUCCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROUTER_FIELD_NUMBER
public static final int ROUTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROUTE_TYPE_FIELD_NUMBER
public static final int ROUTE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListBgpRoutesRoutersRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListBgpRoutesRoutersRequest.Builder newBuilder()
newBuilder(ListBgpRoutesRoutersRequest prototype)
public static ListBgpRoutesRoutersRequest.Builder newBuilder(ListBgpRoutesRoutersRequest prototype)
public static ListBgpRoutesRoutersRequest parseDelimitedFrom(InputStream input)
public static ListBgpRoutesRoutersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListBgpRoutesRoutersRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListBgpRoutesRoutersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListBgpRoutesRoutersRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBgpRoutesRoutersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBgpRoutesRoutersRequest parseFrom(CodedInputStream input)
public static ListBgpRoutesRoutersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListBgpRoutesRoutersRequest parseFrom(InputStream input)
public static ListBgpRoutesRoutersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListBgpRoutesRoutersRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListBgpRoutesRoutersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListBgpRoutesRoutersRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAddressFamily()
public 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 |
| Type |
Description |
String |
The addressFamily.
|
getAddressFamilyBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for addressFamily.
|
getDefaultInstanceForType()
public ListBgpRoutesRoutersRequest getDefaultInstanceForType()
getDestinationPrefix()
public String getDestinationPrefix()
Limit results to destinations that are subnets of this CIDR range
optional string destination_prefix = 263872483;
| Returns |
| Type |
Description |
String |
The destinationPrefix.
|
getDestinationPrefixBytes()
public ByteString getDestinationPrefixBytes()
Limit results to destinations that are subnets of this CIDR range
optional string destination_prefix = 263872483;
| Returns |
| Type |
Description |
ByteString |
The bytes for destinationPrefix.
|
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 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 |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for filter.
|
getMaxResults()
public 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 |
| Type |
Description |
int |
The maxResults.
|
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.
optional string order_by = 160562920;
| Returns |
| Type |
Description |
String |
The orderBy.
|
getOrderByBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for orderBy.
|
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.
optional string page_token = 19994697;
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
getParserForType()
public Parser<ListBgpRoutesRoutersRequest> getParserForType()
Overrides
getPeer()
(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
optional string peer = 3436898;
| Returns |
| Type |
Description |
String |
The peer.
|
getPeerBytes()
public ByteString getPeerBytes()
(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
optional string peer = 3436898;
| Returns |
| Type |
Description |
ByteString |
The bytes for peer.
|
getPolicyApplied()
public boolean getPolicyApplied()
When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
optional bool policy_applied = 379464304;
| Returns |
| Type |
Description |
boolean |
The policyApplied.
|
getProject()
public String getProject()
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The project.
|
getProjectBytes()
public ByteString getProjectBytes()
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for project.
|
getRegion()
public String getRegion()
Name of the region for this request.
string region = 138946292 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The region.
|
getRegionBytes()
public ByteString getRegionBytes()
Name of the region for this request.
string region = 138946292 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for region.
|
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.
optional bool return_partial_success = 517198390;
| Returns |
| Type |
Description |
boolean |
The returnPartialSuccess.
|
getRouteType()
public 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 |
| Type |
Description |
String |
The routeType.
|
getRouteTypeBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for routeType.
|
getRouter()
public 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 |
| Type |
Description |
String |
The router.
|
getRouterBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for router.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasAddressFamily()
public 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 |
| Type |
Description |
boolean |
Whether the addressFamily field is set.
|
hasDestinationPrefix()
public boolean hasDestinationPrefix()
Limit results to destinations that are subnets of this CIDR range
optional string destination_prefix = 263872483;
| Returns |
| Type |
Description |
boolean |
Whether the destinationPrefix field is set.
|
hasFilter()
public 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 |
| Type |
Description |
boolean |
Whether the filter field is set.
|
hasMaxResults()
public 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 |
| Type |
Description |
boolean |
Whether the maxResults field is set.
|
hasOrderBy()
public 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 |
| Type |
Description |
boolean |
Whether the orderBy field is set.
|
hasPageToken()
public 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 |
| Type |
Description |
boolean |
Whether the pageToken field is set.
|
hasPeer()
(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
optional string peer = 3436898;
| Returns |
| Type |
Description |
boolean |
Whether the peer field is set.
|
hasPolicyApplied()
public boolean hasPolicyApplied()
When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
optional bool policy_applied = 379464304;
| Returns |
| Type |
Description |
boolean |
Whether the policyApplied field is set.
|
hasReturnPartialSuccess()
public 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 |
| Type |
Description |
boolean |
Whether the returnPartialSuccess field is set.
|
hasRouteType()
public 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 |
| Type |
Description |
boolean |
Whether the routeType field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListBgpRoutesRoutersRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListBgpRoutesRoutersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListBgpRoutesRoutersRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
