- 1.63.0 (latest)
- 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 AggregatedListNodeGroupsRequest.Builder extends GeneratedMessageV3.Builder<AggregatedListNodeGroupsRequest.Builder> implements AggregatedListNodeGroupsRequestOrBuilder
A request message for NodeGroups.AggregatedList. See the method description for details.
Protobuf type google.cloud.compute.v1.AggregatedListNodeGroupsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AggregatedListNodeGroupsRequest.BuilderImplements
AggregatedListNodeGroupsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AggregatedListNodeGroupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
build()
public AggregatedListNodeGroupsRequest build()
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest |
buildPartial()
public AggregatedListNodeGroupsRequest buildPartial()
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest |
clear()
public AggregatedListNodeGroupsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public AggregatedListNodeGroupsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
clearFilter()
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clearIncludeAllScopes()
public AggregatedListNodeGroupsRequest.Builder clearIncludeAllScopes()
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clearMaxResults()
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AggregatedListNodeGroupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
clearOrderBy()
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clearPageToken()
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clearProject()
public AggregatedListNodeGroupsRequest.Builder clearProject()
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clearReturnPartialSuccess()
public AggregatedListNodeGroupsRequest.Builder clearReturnPartialSuccess()
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
optional bool return_partial_success = 517198390;
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clearServiceProjectNumber()
public AggregatedListNodeGroupsRequest.Builder clearServiceProjectNumber()
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
optional int64 service_project_number = 316757497;
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
clone()
public AggregatedListNodeGroupsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
getDefaultInstanceForType()
public AggregatedListNodeGroupsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
getIncludeAllScopes()
public boolean getIncludeAllScopes()
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
Returns | |
---|---|
Type | Description |
boolean | The includeAllScopes. |
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. |
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. |
getReturnPartialSuccess()
public boolean getReturnPartialSuccess()
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
optional bool return_partial_success = 517198390;
Returns | |
---|---|
Type | Description |
boolean | The returnPartialSuccess. |
getServiceProjectNumber()
public long getServiceProjectNumber()
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
optional int64 service_project_number = 316757497;
Returns | |
---|---|
Type | Description |
long | The serviceProjectNumber. |
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. |
hasIncludeAllScopes()
public boolean hasIncludeAllScopes()
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
Returns | |
---|---|
Type | Description |
boolean | Whether the includeAllScopes 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. |
hasReturnPartialSuccess()
public boolean hasReturnPartialSuccess()
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
optional bool return_partial_success = 517198390;
Returns | |
---|---|
Type | Description |
boolean | Whether the returnPartialSuccess field is set. |
hasServiceProjectNumber()
public boolean hasServiceProjectNumber()
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
optional int64 service_project_number = 316757497;
Returns | |
---|---|
Type | Description |
boolean | Whether the serviceProjectNumber field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(AggregatedListNodeGroupsRequest other)
public AggregatedListNodeGroupsRequest.Builder mergeFrom(AggregatedListNodeGroupsRequest other)
Parameter | |
---|---|
Name | Description |
other | AggregatedListNodeGroupsRequest |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AggregatedListNodeGroupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public AggregatedListNodeGroupsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AggregatedListNodeGroupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public AggregatedListNodeGroupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
setFilter(String value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setIncludeAllScopes(boolean value)
public AggregatedListNodeGroupsRequest.Builder setIncludeAllScopes(boolean value)
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
Parameter | |
---|---|
Name | Description |
value | boolean The includeAllScopes to set. |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setMaxResults(int value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setOrderBy(String value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setProject(String value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setProjectBytes(ByteString value)
public AggregatedListNodeGroupsRequest.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 |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AggregatedListNodeGroupsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |
setReturnPartialSuccess(boolean value)
public AggregatedListNodeGroupsRequest.Builder setReturnPartialSuccess(boolean value)
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
optional bool return_partial_success = 517198390;
Parameter | |
---|---|
Name | Description |
value | boolean The returnPartialSuccess to set. |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setServiceProjectNumber(long value)
public AggregatedListNodeGroupsRequest.Builder setServiceProjectNumber(long value)
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
optional int64 service_project_number = 316757497;
Parameter | |
---|---|
Name | Description |
value | long The serviceProjectNumber to set. |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AggregatedListNodeGroupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AggregatedListNodeGroupsRequest.Builder |