- 1.69.0 (latest)
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class ListBgpRoutesRoutersRequest.Builder extends GeneratedMessageV3.Builder<ListBgpRoutesRoutersRequest.Builder> implements ListBgpRoutesRoutersRequestOrBuilder
A request message for Routers.ListBgpRoutes. See the method description for details.
Protobuf type google.cloud.compute.v1.ListBgpRoutesRoutersRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBgpRoutesRoutersRequest.BuilderImplements
ListBgpRoutesRoutersRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListBgpRoutesRoutersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
build()
public ListBgpRoutesRoutersRequest build()
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest |
buildPartial()
public ListBgpRoutesRoutersRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest |
clear()
public ListBgpRoutesRoutersRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
clearAddressFamily()
public ListBgpRoutesRoutersRequest.Builder clearAddressFamily()
(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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearDestinationPrefix()
public ListBgpRoutesRoutersRequest.Builder clearDestinationPrefix()
Limit results to destinations that are subnets of this CIDR range
optional string destination_prefix = 263872483;
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ListBgpRoutesRoutersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
clearFilter()
public ListBgpRoutesRoutersRequest.Builder clearFilter()
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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearMaxResults()
public ListBgpRoutesRoutersRequest.Builder clearMaxResults()
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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListBgpRoutesRoutersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
clearOrderBy()
public ListBgpRoutesRoutersRequest.Builder clearOrderBy()
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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListBgpRoutesRoutersRequest.Builder clearPageToken()
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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearPeer()
public ListBgpRoutesRoutersRequest.Builder clearPeer()
(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
optional string peer = 3436898;
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearPolicyApplied()
public ListBgpRoutesRoutersRequest.Builder clearPolicyApplied()
When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
optional bool policy_applied = 379464304;
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearProject()
public ListBgpRoutesRoutersRequest.Builder clearProject()
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearRegion()
public ListBgpRoutesRoutersRequest.Builder clearRegion()
Name of the region for this request.
string region = 138946292 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearReturnPartialSuccess()
public ListBgpRoutesRoutersRequest.Builder clearReturnPartialSuccess()
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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearRouteType()
public ListBgpRoutesRoutersRequest.Builder clearRouteType()
(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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clearRouter()
public ListBgpRoutesRoutersRequest.Builder clearRouter()
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 |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
clone()
public ListBgpRoutesRoutersRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
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()
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getPeer()
public String 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. |
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()
public boolean 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListBgpRoutesRoutersRequest other)
public ListBgpRoutesRoutersRequest.Builder mergeFrom(ListBgpRoutesRoutersRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListBgpRoutesRoutersRequest |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListBgpRoutesRoutersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListBgpRoutesRoutersRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListBgpRoutesRoutersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
setAddressFamily(String value)
public ListBgpRoutesRoutersRequest.Builder setAddressFamily(String value)
(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;
Parameter | |
---|---|
Name | Description |
value |
String The addressFamily to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setAddressFamilyBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setAddressFamilyBytes(ByteString value)
(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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for addressFamily to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setDestinationPrefix(String value)
public ListBgpRoutesRoutersRequest.Builder setDestinationPrefix(String value)
Limit results to destinations that are subnets of this CIDR range
optional string destination_prefix = 263872483;
Parameter | |
---|---|
Name | Description |
value |
String The destinationPrefix to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setDestinationPrefixBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setDestinationPrefixBytes(ByteString value)
Limit results to destinations that are subnets of this CIDR range
optional string destination_prefix = 263872483;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for destinationPrefix to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ListBgpRoutesRoutersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
setFilter(String value)
public ListBgpRoutesRoutersRequest.Builder setFilter(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setFilterBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setMaxResults(int value)
public ListBgpRoutesRoutersRequest.Builder setMaxResults(int value)
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;
Parameter | |
---|---|
Name | Description |
value |
int The maxResults to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListBgpRoutesRoutersRequest.Builder setOrderBy(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The orderBy to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setOrderByBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for orderBy to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListBgpRoutesRoutersRequest.Builder setPageToken(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setPageTokenBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setPeer(String value)
public ListBgpRoutesRoutersRequest.Builder setPeer(String value)
(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
optional string peer = 3436898;
Parameter | |
---|---|
Name | Description |
value |
String The peer to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setPeerBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setPeerBytes(ByteString value)
(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
optional string peer = 3436898;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for peer to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setPolicyApplied(boolean value)
public ListBgpRoutesRoutersRequest.Builder setPolicyApplied(boolean value)
When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
optional bool policy_applied = 379464304;
Parameter | |
---|---|
Name | Description |
value |
boolean The policyApplied to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setProject(String value)
public ListBgpRoutesRoutersRequest.Builder setProject(String value)
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The project to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setProjectBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setProjectBytes(ByteString value)
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for project to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setRegion(String value)
public ListBgpRoutesRoutersRequest.Builder setRegion(String value)
Name of the region for this request.
string region = 138946292 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The region to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setRegionBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setRegionBytes(ByteString value)
Name of the region for this request.
string region = 138946292 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for region to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListBgpRoutesRoutersRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
setReturnPartialSuccess(boolean value)
public ListBgpRoutesRoutersRequest.Builder setReturnPartialSuccess(boolean value)
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;
Parameter | |
---|---|
Name | Description |
value |
boolean The returnPartialSuccess to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setRouteType(String value)
public ListBgpRoutesRoutersRequest.Builder setRouteType(String value)
(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;
Parameter | |
---|---|
Name | Description |
value |
String The routeType to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setRouteTypeBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setRouteTypeBytes(ByteString value)
(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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for routeType to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setRouter(String value)
public ListBgpRoutesRoutersRequest.Builder setRouter(String value)
Name or id of the resource for this request. Name should conform to RFC1035.
string router = 148608841 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The router to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setRouterBytes(ByteString value)
public ListBgpRoutesRoutersRequest.Builder setRouterBytes(ByteString value)
Name or id of the resource for this request. Name should conform to RFC1035.
string router = 148608841 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for router to set. |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListBgpRoutesRoutersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListBgpRoutesRoutersRequest.Builder |