Class ListInstancesRegionInstanceGroupsRequest.Builder (1.31.0)

Version 1.31.0

• 1.65.0 (latest)
• 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 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListInstancesRegionInstanceGroupsRequest.Builder

Implements

ListInstancesRegionInstanceGroupsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRegionInstanceGroupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListInstancesRegionInstanceGroupsRequest build()

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest

buildPartial()

public ListInstancesRegionInstanceGroupsRequest buildPartial()

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest

clear()

public ListInstancesRegionInstanceGroupsRequest.Builder clear()

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListInstancesRegionInstanceGroupsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
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
Type	Description
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
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInstancesRegionInstanceGroupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder	This builder for chaining.

clone()

public ListInstancesRegionInstanceGroupsRequest.Builder clone()

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListInstancesRegionInstanceGroupsRequest getDefaultInstanceForType()

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
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. 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
Type	Description
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
Type	Description
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
Type	Description
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
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.

getRegion()

public String getRegion()

Name of the region scoping this request.

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

Returns
Type	Description
String	The region.

getRegionBytes()

public ByteString getRegionBytes()

Name of the region scoping this request.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
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.

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
Type	Description
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
Type	Description
boolean	Whether the returnPartialSuccess field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListInstancesRegionInstanceGroupsRequest other)

public ListInstancesRegionInstanceGroupsRequest.Builder mergeFrom(ListInstancesRegionInstanceGroupsRequest other)

Parameter
Name	Description
other	ListInstancesRegionInstanceGroupsRequest

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListInstancesRegionInstanceGroupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListInstancesRegionInstanceGroupsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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
Name	Description
value	RegionInstanceGroupsListInstancesRequest

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRegionInstanceGroupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRegionInstanceGroupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
value	String The filter to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
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
Name	Description
value	String The instanceGroup to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for instanceGroup to set.

Returns
Type	Description
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
Name	Description
value	int The maxResults to set.

Returns
Type	Description
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
Name	Description
value	String The orderBy to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for orderBy to set.

Returns
Type	Description
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
Name	Description
value	String The pageToken to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for pageToken to set.

Returns
Type	Description
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
Name	Description
value	String The project to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for project to set.

Returns
Type	Description
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
Name	Description
value	String The region to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for region to set.

Returns
Type	Description
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
Name	Description
value	RegionInstanceGroupsListInstancesRequest

Returns
Type	Description
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
Name	Description
builderForValue	RegionInstanceGroupsListInstancesRequest.Builder

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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
Name	Description
value	boolean The returnPartialSuccess to set.

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRegionInstanceGroupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListInstancesRegionInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)