public final class AggregatedListMachineTypesRequest extends GeneratedMessageV3 implements AggregatedListMachineTypesRequestOrBuilder
A request message for MachineTypes.AggregatedList. See the method description for details.
Protobuf type google.cloud.compute.v1.AggregatedListMachineTypesRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
INCLUDE_ALL_SCOPES_FIELD_NUMBER
public static final int INCLUDE_ALL_SCOPES_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
Static Methods
getDefaultInstance()
public static AggregatedListMachineTypesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AggregatedListMachineTypesRequest.Builder newBuilder()
Returns
newBuilder(AggregatedListMachineTypesRequest prototype)
public static AggregatedListMachineTypesRequest.Builder newBuilder(AggregatedListMachineTypesRequest prototype)
Parameter
Returns
public static AggregatedListMachineTypesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AggregatedListMachineTypesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AggregatedListMachineTypesRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AggregatedListMachineTypesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AggregatedListMachineTypesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregatedListMachineTypesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AggregatedListMachineTypesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AggregatedListMachineTypesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AggregatedListMachineTypesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AggregatedListMachineTypesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AggregatedListMachineTypesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AggregatedListMachineTypesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AggregatedListMachineTypesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public AggregatedListMachineTypesRequest getDefaultInstanceForType()
Returns
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
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;
Returns
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;
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
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
getParserForType()
public Parser<AggregatedListMachineTypesRequest> getParserForType()
Returns
Overrides
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
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.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
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;
Returns
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;
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AggregatedListMachineTypesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AggregatedListMachineTypesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AggregatedListMachineTypesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions