public final class ListInstancesInstanceGroupsRequest extends GeneratedMessageV3 implements ListInstancesInstanceGroupsRequestOrBuilder
A request message for InstanceGroups.ListInstances. See the method description for details.
Protobuf type google.cloud.compute.v1.ListInstancesInstanceGroupsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
INSTANCE_GROUPS_LIST_INSTANCES_REQUEST_RESOURCE_FIELD_NUMBER
public static final int INSTANCE_GROUPS_LIST_INSTANCES_REQUEST_RESOURCE_FIELD_NUMBER
Field Value
INSTANCE_GROUP_FIELD_NUMBER
public static final int INSTANCE_GROUP_FIELD_NUMBER
Field Value
MAX_RESULTS_FIELD_NUMBER
public static final int MAX_RESULTS_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PROJECT_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER
Field Value
RETURN_PARTIAL_SUCCESS_FIELD_NUMBER
public static final int RETURN_PARTIAL_SUCCESS_FIELD_NUMBER
Field Value
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListInstancesInstanceGroupsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListInstancesInstanceGroupsRequest.Builder newBuilder()
Returns
newBuilder(ListInstancesInstanceGroupsRequest prototype)
public static ListInstancesInstanceGroupsRequest.Builder newBuilder(ListInstancesInstanceGroupsRequest prototype)
Parameter
Returns
public static ListInstancesInstanceGroupsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListInstancesInstanceGroupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListInstancesInstanceGroupsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesInstanceGroupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListInstancesInstanceGroupsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesInstanceGroupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListInstancesInstanceGroupsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListInstancesInstanceGroupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListInstancesInstanceGroupsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListInstancesInstanceGroupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListInstancesInstanceGroupsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListInstancesInstanceGroupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListInstancesInstanceGroupsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListInstancesInstanceGroupsRequest getDefaultInstanceForType()
Returns
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;
| 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;
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];
| 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];
| 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];
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];
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;
| 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;
| 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;
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;
| 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;
getParserForType()
public Parser<ListInstancesInstanceGroupsRequest> getParserForType()
Returns
Overrides
getProject()
public String getProject()
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The project.
|
getProjectBytes()
public ByteString getProjectBytes()
Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
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;
| Type | Description |
| boolean | The returnPartialSuccess.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getZone()
The name of the zone where the instance group is located.
string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];
| 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];
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;
| 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];
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the returnPartialSuccess field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListInstancesInstanceGroupsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListInstancesInstanceGroupsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListInstancesInstanceGroupsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
