- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class AggregatedListInstancesRequest.Builder extends GeneratedMessageV3.Builder<AggregatedListInstancesRequest.Builder> implements AggregatedListInstancesRequestOrBuilderA request message for Instances.AggregatedList. See the method description for details.
Protobuf type google.cloud.compute.v1.AggregatedListInstancesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AggregatedListInstancesRequest.BuilderImplements
AggregatedListInstancesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AggregatedListInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
build()
public AggregatedListInstancesRequest build()| Type | Description |
| AggregatedListInstancesRequest |
buildPartial()
public AggregatedListInstancesRequest buildPartial()| Type | Description |
| AggregatedListInstancesRequest |
clear()
public AggregatedListInstancesRequest.Builder clear()| Type | Description |
| AggregatedListInstancesRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public AggregatedListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
clearFilter()
public AggregatedListInstancesRequest.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;
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
clearIncludeAllScopes()
public AggregatedListInstancesRequest.Builder clearIncludeAllScopes()Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
clearMaxResults()
public AggregatedListInstancesRequest.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;
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AggregatedListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
clearOrderBy()
public AggregatedListInstancesRequest.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;
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
clearPageToken()
public AggregatedListInstancesRequest.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;
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
clearProject()
public AggregatedListInstancesRequest.Builder clearProject()Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
clearReturnPartialSuccess()
public AggregatedListInstancesRequest.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;
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
clone()
public AggregatedListInstancesRequest.Builder clone()| Type | Description |
| AggregatedListInstancesRequest.Builder |
getDefaultInstanceForType()
public AggregatedListInstancesRequest getDefaultInstanceForType()| Type | Description |
| AggregatedListInstancesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| Type | Description |
| ByteString | The bytes for filter. |
getIncludeAllScopes()
public boolean getIncludeAllScopes()Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
| Type | Description |
| boolean | The includeAllScopes. |
getMaxResults()
public int getMaxResults() The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
optional uint32 max_results = 54715419;
| 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;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for pageToken. |
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];
| 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;
| Type | Description |
| boolean | The returnPartialSuccess. |
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. |
hasIncludeAllScopes()
public boolean hasIncludeAllScopes()Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
| Type | Description |
| boolean | Whether the includeAllScopes field is set. |
hasMaxResults()
public boolean hasMaxResults() The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
optional uint32 max_results = 54715419;
| 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(AggregatedListInstancesRequest other)
public AggregatedListInstancesRequest.Builder mergeFrom(AggregatedListInstancesRequest other)| Name | Description |
| other | AggregatedListInstancesRequest |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AggregatedListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public AggregatedListInstancesRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AggregatedListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public AggregatedListInstancesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
setFilter(String value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | StringThe filter to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | ByteStringThe bytes for filter to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setIncludeAllScopes(boolean value)
public AggregatedListInstancesRequest.Builder setIncludeAllScopes(boolean value)Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
optional bool include_all_scopes = 391327988;
| Name | Description |
| value | booleanThe includeAllScopes to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setMaxResults(int value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | intThe maxResults to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setOrderBy(String value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | StringThe orderBy to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | ByteStringThe bytes for orderBy to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | StringThe pageToken to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | ByteStringThe bytes for pageToken to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setProject(String value)
public AggregatedListInstancesRequest.Builder setProject(String value)Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | StringThe project to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setProjectBytes(ByteString value)
public AggregatedListInstancesRequest.Builder setProjectBytes(ByteString value)Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | ByteStringThe bytes for project to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AggregatedListInstancesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| AggregatedListInstancesRequest.Builder |
setReturnPartialSuccess(boolean value)
public AggregatedListInstancesRequest.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;
| Name | Description |
| value | booleanThe returnPartialSuccess to set. |
| Type | Description |
| AggregatedListInstancesRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AggregatedListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| AggregatedListInstancesRequest.Builder |