Class ListInstancesInstanceGroupsRequest.Builder (1.7.2)

Version 1.7.2

• 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 ListInstancesInstanceGroupsRequest.Builder extends GeneratedMessageV3.Builder<ListInstancesInstanceGroupsRequest.Builder> implements ListInstancesInstanceGroupsRequestOrBuilder

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

Protobuf type google.cloud.compute.v1.ListInstancesInstanceGroupsRequest

Inheritance

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

Implements

ListInstancesInstanceGroupsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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.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)

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)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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 ListInstancesInstanceGroupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

build()

public ListInstancesInstanceGroupsRequest build()

Returns

Type	Description
ListInstancesInstanceGroupsRequest

buildPartial()

public ListInstancesInstanceGroupsRequest buildPartial()

Returns

Type	Description
ListInstancesInstanceGroupsRequest

clear()

public ListInstancesInstanceGroupsRequest.Builder clear()

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListInstancesInstanceGroupsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

clearFilter()

public ListInstancesInstanceGroupsRequest.Builder clearFilter()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clearInstanceGroup()

public ListInstancesInstanceGroupsRequest.Builder clearInstanceGroup()

The name of the instance group from which you want to generate a list of included instances.

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

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clearInstanceGroupsListInstancesRequestResource()

public ListInstancesInstanceGroupsRequest.Builder clearInstanceGroupsListInstancesRequestResource()

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

clearMaxResults()

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInstancesInstanceGroupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

clearOrderBy()

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clearPageToken()

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clearProject()

public ListInstancesInstanceGroupsRequest.Builder clearProject()

Project ID for this request.

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

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clearReturnPartialSuccess()

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clearZone()

public ListInstancesInstanceGroupsRequest.Builder clearZone()

The name of the zone where the instance group is located.

string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

clone()

public ListInstancesInstanceGroupsRequest.Builder clone()

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListInstancesInstanceGroupsRequest getDefaultInstanceForType()

Returns

Type	Description
ListInstancesInstanceGroupsRequest

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. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns

Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns

Type	Description
ByteString	The bytes for filter.

getInstanceGroup()

public String getInstanceGroup()

The name of the instance group from which you want to generate a list of included instances.

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

Returns

Type	Description
String	The instanceGroup.

getInstanceGroupBytes()

public ByteString getInstanceGroupBytes()

The name of the instance group from which you want to generate a list of included instances.

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

Returns

Type	Description
ByteString	The bytes for instanceGroup.

getInstanceGroupsListInstancesRequestResource()

public InstanceGroupsListInstancesRequest getInstanceGroupsListInstancesRequestResource()

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
InstanceGroupsListInstancesRequest	The instanceGroupsListInstancesRequestResource.

getInstanceGroupsListInstancesRequestResourceBuilder()

public InstanceGroupsListInstancesRequest.Builder getInstanceGroupsListInstancesRequestResourceBuilder()

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
InstanceGroupsListInstancesRequest.Builder

getInstanceGroupsListInstancesRequestResourceOrBuilder()

public InstanceGroupsListInstancesRequestOrBuilder getInstanceGroupsListInstancesRequestResourceOrBuilder()

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
InstanceGroupsListInstancesRequestOrBuilder

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.

getZone()

public String getZone()

The name of the zone where the instance group is located.

string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The zone.

getZoneBytes()

public ByteString getZoneBytes()

The name of the zone where the instance group is located.

string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for zone.

hasFilter()

public boolean hasFilter()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns

Type	Description
boolean	Whether the filter field is set.

hasInstanceGroupsListInstancesRequestResource()

public boolean hasInstanceGroupsListInstancesRequestResource()

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the instanceGroupsListInstancesRequestResource 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.

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(ListInstancesInstanceGroupsRequest other)

public ListInstancesInstanceGroupsRequest.Builder mergeFrom(ListInstancesInstanceGroupsRequest other)

Parameter

Name	Description
other	ListInstancesInstanceGroupsRequest

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListInstancesInstanceGroupsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

mergeInstanceGroupsListInstancesRequestResource(InstanceGroupsListInstancesRequest value)

public ListInstancesInstanceGroupsRequest.Builder mergeInstanceGroupsListInstancesRequestResource(InstanceGroupsListInstancesRequest value)

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	InstanceGroupsListInstancesRequest

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesInstanceGroupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

setFilter(String value)

public ListInstancesInstanceGroupsRequest.Builder setFilter(String value)

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Parameter

Name	Description
value	String The filter to set.

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListInstancesInstanceGroupsRequest.Builder setFilterBytes(ByteString value)

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Parameter

Name	Description
value	ByteString The bytes for filter to set.

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setInstanceGroup(String value)

public ListInstancesInstanceGroupsRequest.Builder setInstanceGroup(String value)

The name of the instance group from which you want to generate a list of included instances.

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

Parameter

Name	Description
value	String The instanceGroup to set.

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setInstanceGroupBytes(ByteString value)

public ListInstancesInstanceGroupsRequest.Builder setInstanceGroupBytes(ByteString value)

The name of the instance group from which you want to generate a list of included instances.

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

Parameter

Name	Description
value	ByteString The bytes for instanceGroup to set.

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setInstanceGroupsListInstancesRequestResource(InstanceGroupsListInstancesRequest value)

public ListInstancesInstanceGroupsRequest.Builder setInstanceGroupsListInstancesRequestResource(InstanceGroupsListInstancesRequest value)

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	InstanceGroupsListInstancesRequest

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

setInstanceGroupsListInstancesRequestResource(InstanceGroupsListInstancesRequest.Builder builderForValue)

public ListInstancesInstanceGroupsRequest.Builder setInstanceGroupsListInstancesRequestResource(InstanceGroupsListInstancesRequest.Builder builderForValue)

The body resource for this request

.google.cloud.compute.v1.InstanceGroupsListInstancesRequest instance_groups_list_instances_request_resource = 476255263 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	InstanceGroupsListInstancesRequest.Builder

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

setMaxResults(int value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setOrderBy(String value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setProject(String value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setProjectBytes(ByteString value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

setReturnPartialSuccess(boolean value)

public ListInstancesInstanceGroupsRequest.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
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesInstanceGroupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder

Overrides

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

setZone(String value)

public ListInstancesInstanceGroupsRequest.Builder setZone(String value)

The name of the zone where the instance group is located.

string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	String The zone to set.

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.

setZoneBytes(ByteString value)

public ListInstancesInstanceGroupsRequest.Builder setZoneBytes(ByteString value)

The name of the zone where the instance group is located.

string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	ByteString The bytes for zone to set.

Returns

Type	Description
ListInstancesInstanceGroupsRequest.Builder	This builder for chaining.