Compute V1 Client - Class ListMachineImagesRequest (2.5.0)

Reference documentation and code samples for the Compute V1 Client class ListMachineImagesRequest.

A request message for MachineImages.List. See the method description for details.

Generated from protobuf messagegoogle.cloud.compute.v1.ListMachineImagesRequest

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ filterstring

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. These two types of filter expressions cannot be mixed in one request. 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 namedexample-instance by specifyingname != example-instance. The:* comparison can be used to test whether a key has been defined. For example, to find all objects withowner label use:labels.owner:* You can also filter nested fields. For example, you could specifyscheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource 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 anAND expression. However, you can includeAND andOR expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use theeq (equal) orne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:fieldname eq unquoted literalfieldname 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 GoogleRE2 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 usename ne .*instance. You cannot combine constraints on multiple fields using regular expressions.

↳ max_resultsint

The maximum number of results per page that should be returned. If the number of available results is larger thanmaxResults, Compute Engine returns anextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)

↳ order_bystring

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 usingorderBy="creationTimestamp desc". This sorts results based on thecreationTimestamp 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 byname orcreationTimestamp desc is supported.

↳ page_tokenstring

Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to get the next page of results.

↳ projectstring

Project ID for this request.

↳ return_partial_successbool

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

getFilter

A filter expression that filters resources listed in the response. MostCompute resources support two types of filter expressions:expressions that support regular expressions and expressions that followAPI improvement proposal AIP-160.

These two types of filter expressions cannot be mixed in one request.If you want to use AIP-160, your expression must specify the field name, anoperator, and the value that you want to use for filtering. The valuemust be a string, a number, or a boolean. The operatormust be either=,!=,>,<,<=,>= or:.For example, if you are filtering Compute Engine instances, you canexclude instances namedexample-instance by specifyingname != example-instance.The:* comparison can be used to test whether a key has been defined.For example, to find all objects withowner label use:

labels.owner:*

You can also filter nested fields. For example, you could specifyscheduling.automaticRestart = false to include instances onlyif they are not scheduled for automatic restarts. You can use filteringon nested fields to filter based onresource labels.To filter on multiple expressions, provide each separate expression withinparentheses. For example:

(scheduling.automaticRestart = true)(cpuPlatform = "Intel Skylake")

By default, each expression is anAND expression. However, youcan includeAND andOR expressions explicitly.For example:

(cpuPlatform = "Intel Skylake") OR(cpuPlatform = "Intel Broadwell") AND(scheduling.automaticRestart = true)

If you want to use a regular expression, use theeq (equal) orne(not equal) operator against a single un-parenthesized expression with orwithout quotes or against multiple parenthesized expressions. Examples:fieldname eq unquoted literalfieldname 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 GoogleRE2 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 usename ne .*instance.You cannot combine constraints on multiple fields using regularexpressions.

Returns
TypeDescription
string

hasFilter

clearFilter

setFilter

A filter expression that filters resources listed in the response. MostCompute resources support two types of filter expressions:expressions that support regular expressions and expressions that followAPI improvement proposal AIP-160.

These two types of filter expressions cannot be mixed in one request.If you want to use AIP-160, your expression must specify the field name, anoperator, and the value that you want to use for filtering. The valuemust be a string, a number, or a boolean. The operatormust be either=,!=,>,<,<=,>= or:.For example, if you are filtering Compute Engine instances, you canexclude instances namedexample-instance by specifyingname != example-instance.The:* comparison can be used to test whether a key has been defined.For example, to find all objects withowner label use:

labels.owner:*

You can also filter nested fields. For example, you could specifyscheduling.automaticRestart = false to include instances onlyif they are not scheduled for automatic restarts. You can use filteringon nested fields to filter based onresource labels.To filter on multiple expressions, provide each separate expression withinparentheses. For example:

(scheduling.automaticRestart = true)(cpuPlatform = "Intel Skylake")

By default, each expression is anAND expression. However, youcan includeAND andOR expressions explicitly.For example:

(cpuPlatform = "Intel Skylake") OR(cpuPlatform = "Intel Broadwell") AND(scheduling.automaticRestart = true)

If you want to use a regular expression, use theeq (equal) orne(not equal) operator against a single un-parenthesized expression with orwithout quotes or against multiple parenthesized expressions. Examples:fieldname eq unquoted literalfieldname 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 GoogleRE2 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 usename ne .*instance.You cannot combine constraints on multiple fields using regularexpressions.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getMaxResults

The maximum number of results per page that should be returned.

If the number of available results is larger thanmaxResults,Compute Engine returns anextPageToken that can be used to getthe next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)

Returns
TypeDescription
int

hasMaxResults

clearMaxResults

setMaxResults

The maximum number of results per page that should be returned.

If the number of available results is larger thanmaxResults,Compute Engine returns anextPageToken that can be used to getthe next page of results in subsequent list requests. Acceptable values are0 to500, inclusive. (Default:500)

Parameter
NameDescription
varint
Returns
TypeDescription
$this

getOrderBy

Sorts list results by a certain order. By default, resultsare returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creationtimestamp usingorderBy="creationTimestamp desc". This sortsresults based on thecreationTimestamp field inreverse chronological order (newest result first). Use this to sortresources like operations so that the newest operation is returned first.Currently, only sorting byname orcreationTimestamp desc is supported.

Returns
TypeDescription
string

hasOrderBy

clearOrderBy

setOrderBy

Sorts list results by a certain order. By default, resultsare returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creationtimestamp usingorderBy="creationTimestamp desc". This sortsresults based on thecreationTimestamp field inreverse chronological order (newest result first). Use this to sortresources like operations so that the newest operation is returned first.Currently, only sorting byname orcreationTimestamp desc is supported.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getPageToken

Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to getthe next page of results.

Returns
TypeDescription
string

hasPageToken

clearPageToken

setPageToken

Specifies a page token to use. SetpageToken to thenextPageToken returned by a previous list request to getthe next page of results.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getProject

Project ID for this request.

Returns
TypeDescription
string

setProject

Project ID for this request.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getReturnPartialSuccess

Opt-in for partial success behavior which provides partial results in caseof failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for asingle zone scope either returns all resources in the zone or no resources,with an error code.

Returns
TypeDescription
bool

hasReturnPartialSuccess

clearReturnPartialSuccess

setReturnPartialSuccess

Opt-in for partial success behavior which provides partial results in caseof failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for asingle zone scope either returns all resources in the zone or no resources,with an error code.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
projectstring

Project ID for this request.

Returns
TypeDescription
ListMachineImagesRequest

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-23 UTC.