Class ListInstancesRegionInstanceGroupsRequest.Builder (1.37.0)

public static final class ListInstancesRegionInstanceGroupsRequest.Builder extends GeneratedMessageV3.Builder<ListInstancesRegionInstanceGroupsRequest.Builder> implements ListInstancesRegionInstanceGroupsRequestOrBuilder

A request message for RegionInstanceGroups.ListInstances. See the method description for details.

Protobuf type google.cloud.compute.v1.ListInstancesRegionInstanceGroupsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRegionInstanceGroupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

build()

public ListInstancesRegionInstanceGroupsRequest build()
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest

buildPartial()

public ListInstancesRegionInstanceGroupsRequest buildPartial()
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest

clear()

public ListInstancesRegionInstanceGroupsRequest.Builder clear()
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListInstancesRegionInstanceGroupsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

clearFilter()

public ListInstancesRegionInstanceGroupsRequest.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. 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 : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. 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`.

optional string filter = 336120696;

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clearInstanceGroup()

public ListInstancesRegionInstanceGroupsRequest.Builder clearInstanceGroup()

Name of the regional instance group for which we want to list the instances.

string instance_group = 81095253 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clearMaxResults()

public ListInstancesRegionInstanceGroupsRequest.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
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInstancesRegionInstanceGroupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

clearOrderBy()

public ListInstancesRegionInstanceGroupsRequest.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
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clearPageToken()

public ListInstancesRegionInstanceGroupsRequest.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
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clearProject()

public ListInstancesRegionInstanceGroupsRequest.Builder clearProject()

Project ID for this request.

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

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clearRegion()

public ListInstancesRegionInstanceGroupsRequest.Builder clearRegion()

Name of the region scoping this request.

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

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clearRegionInstanceGroupsListInstancesRequestResource()

public ListInstancesRegionInstanceGroupsRequest.Builder clearRegionInstanceGroupsListInstancesRequestResource()

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

clearReturnPartialSuccess()

public ListInstancesRegionInstanceGroupsRequest.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
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

clone()

public ListInstancesRegionInstanceGroupsRequest.Builder clone()
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListInstancesRegionInstanceGroupsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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. 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 : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. 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`.

optional string filter = 336120696;

Returns
TypeDescription
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. 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 : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. 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`.

optional string filter = 336120696;

Returns
TypeDescription
ByteString

The bytes for filter.

getInstanceGroup()

public String getInstanceGroup()

Name of the regional instance group for which we want to list the instances.

string instance_group = 81095253 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The instanceGroup.

getInstanceGroupBytes()

public ByteString getInstanceGroupBytes()

Name of the regional instance group for which we want to list the instances.

string instance_group = 81095253 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for instanceGroup.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageToken.

getProject()

public String getProject()

Project ID for this request.

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

Returns
TypeDescription
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Project ID for this request.

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

Returns
TypeDescription
ByteString

The bytes for project.

getRegion()

public String getRegion()

Name of the region scoping this request.

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

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

Name of the region scoping this request.

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

Returns
TypeDescription
ByteString

The bytes for region.

getRegionInstanceGroupsListInstancesRequestResource()

public RegionInstanceGroupsListInstancesRequest getRegionInstanceGroupsListInstancesRequestResource()

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RegionInstanceGroupsListInstancesRequest

The regionInstanceGroupsListInstancesRequestResource.

getRegionInstanceGroupsListInstancesRequestResourceBuilder()

public RegionInstanceGroupsListInstancesRequest.Builder getRegionInstanceGroupsListInstancesRequestResourceBuilder()

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RegionInstanceGroupsListInstancesRequest.Builder

getRegionInstanceGroupsListInstancesRequestResourceOrBuilder()

public RegionInstanceGroupsListInstancesRequestOrBuilder getRegionInstanceGroupsListInstancesRequestResourceOrBuilder()

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RegionInstanceGroupsListInstancesRequestOrBuilder

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
TypeDescription
boolean

The returnPartialSuccess.

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. 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 : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. 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`.

optional string filter = 336120696;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the pageToken field is set.

hasRegionInstanceGroupsListInstancesRequestResource()

public boolean hasRegionInstanceGroupsListInstancesRequestResource()

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the regionInstanceGroupsListInstancesRequestResource 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
TypeDescription
boolean

Whether the returnPartialSuccess field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListInstancesRegionInstanceGroupsRequest other)

public ListInstancesRegionInstanceGroupsRequest.Builder mergeFrom(ListInstancesRegionInstanceGroupsRequest other)
Parameter
NameDescription
otherListInstancesRegionInstanceGroupsRequest
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListInstancesRegionInstanceGroupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListInstancesRegionInstanceGroupsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

mergeRegionInstanceGroupsListInstancesRequestResource(RegionInstanceGroupsListInstancesRequest value)

public ListInstancesRegionInstanceGroupsRequest.Builder mergeRegionInstanceGroupsListInstancesRequestResource(RegionInstanceGroupsListInstancesRequest value)

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueRegionInstanceGroupsListInstancesRequest
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRegionInstanceGroupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRegionInstanceGroupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

setFilter(String value)

public ListInstancesRegionInstanceGroupsRequest.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. 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 : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. 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`.

optional string filter = 336120696;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListInstancesRegionInstanceGroupsRequest.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. 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 : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. 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`.

optional string filter = 336120696;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setInstanceGroup(String value)

public ListInstancesRegionInstanceGroupsRequest.Builder setInstanceGroup(String value)

Name of the regional instance group for which we want to list the instances.

string instance_group = 81095253 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The instanceGroup to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setInstanceGroupBytes(ByteString value)

public ListInstancesRegionInstanceGroupsRequest.Builder setInstanceGroupBytes(ByteString value)

Name of the regional instance group for which we want to list the instances.

string instance_group = 81095253 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for instanceGroup to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setMaxResults(int value)

public ListInstancesRegionInstanceGroupsRequest.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
NameDescription
valueint

The maxResults to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListInstancesRegionInstanceGroupsRequest.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
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListInstancesRegionInstanceGroupsRequest.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
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListInstancesRegionInstanceGroupsRequest.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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInstancesRegionInstanceGroupsRequest.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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setProject(String value)

public ListInstancesRegionInstanceGroupsRequest.Builder setProject(String value)

Project ID for this request.

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

Parameter
NameDescription
valueString

The project to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public ListInstancesRegionInstanceGroupsRequest.Builder setProjectBytes(ByteString value)

Project ID for this request.

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

Parameter
NameDescription
valueByteString

The bytes for project to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setRegion(String value)

public ListInstancesRegionInstanceGroupsRequest.Builder setRegion(String value)

Name of the region scoping this request.

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

Parameter
NameDescription
valueString

The region to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public ListInstancesRegionInstanceGroupsRequest.Builder setRegionBytes(ByteString value)

Name of the region scoping this request.

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

Parameter
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setRegionInstanceGroupsListInstancesRequestResource(RegionInstanceGroupsListInstancesRequest value)

public ListInstancesRegionInstanceGroupsRequest.Builder setRegionInstanceGroupsListInstancesRequestResource(RegionInstanceGroupsListInstancesRequest value)

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueRegionInstanceGroupsListInstancesRequest
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

setRegionInstanceGroupsListInstancesRequestResource(RegionInstanceGroupsListInstancesRequest.Builder builderForValue)

public ListInstancesRegionInstanceGroupsRequest.Builder setRegionInstanceGroupsListInstancesRequestResource(RegionInstanceGroupsListInstancesRequest.Builder builderForValue)

The body resource for this request

.google.cloud.compute.v1.RegionInstanceGroupsListInstancesRequest region_instance_groups_list_instances_request_resource = 48239828 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueRegionInstanceGroupsListInstancesRequest.Builder
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListInstancesRegionInstanceGroupsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides

setReturnPartialSuccess(boolean value)

public ListInstancesRegionInstanceGroupsRequest.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
NameDescription
valueboolean

The returnPartialSuccess to set.

Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRegionInstanceGroupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInstancesRegionInstanceGroupsRequest.Builder
Overrides