Compute V1 Client - Class ListManagedInstancesInstanceGroupManagersRequest (1.10.1)

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

A request message for InstanceGroupManagers.ListManagedInstances. See the method description for details.

Generated from protobuf message google.cloud.compute.v1.ListManagedInstancesInstanceGroupManagersRequest

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ filter`	`string` 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`.
`↳ instance_group_manager`	`string` The name of the managed instance group.
`↳ max_results`	`int` 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`)
`↳ order_by`	`string` 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.
`↳ page_token`	`string` Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
`↳ project`	`string` Project ID for this request.
`↳ return_partial_success`	`bool` Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
`↳ zone`	`string` The name of the zone where the managed instance group is located.

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.

Returns
Type	Description
`string`

hasFilter

clearFilter

setFilter

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInstanceGroupManager

The name of the managed instance group.

Returns
Type	Description
`string`

setInstanceGroupManager

The name of the managed instance group.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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)

Returns
Type	Description
`int`

hasMaxResults

clearMaxResults

setMaxResults

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasOrderBy

clearOrderBy

setOrderBy

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`string`

hasPageToken

clearPageToken

setPageToken

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProject

Project ID for this request.

Returns
Type	Description
`string`

setProject

Project ID for this request.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReturnPartialSuccess

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

Returns
Type	Description
`bool`

hasReturnPartialSuccess

clearReturnPartialSuccess

setReturnPartialSuccess

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getZone

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

Returns
Type	Description
`string`

setZone

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`project`	`string` Project ID for this request.
`zone`	`string` The name of the zone where the managed instance group is located.
`instanceGroupManager`	`string` The name of the managed instance group.

Returns
Type	Description
`Google\Cloud\Compute\V1\ListManagedInstancesInstanceGroupManagersRequest`