Retrieves the list of all VM Extension Policy resources
Retrieves the next page of results.
Close httplib2 connections.
get(project, globalVmExtensionPolicy, x__xgafv=None)
Gets details of a global VM extension policy.
aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
Retrieves the list of all VM Extension Policy resources
available to the specified project.
To prevent failure, it's recommended that you set the
`returnPartialSuccess` parameter to `true`.
Args:
project: string, Name of the project scoping this request. (required)
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.
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 named `example-instance` by specifying
`name != example-instance`.
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 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 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 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 use `name ne .*instance`.
You cannot combine constraints on multiple fields using regular
expressions.
includeAllScopes: boolean, 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.
maxResults: integer, 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`)
orderBy: 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.
pageToken: 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.
returnPartialSuccess: boolean, 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.
serviceProjectNumber: string, The Shared VPC service project id or service project number for which
aggregated list request is invoked for subnetworks list-usable api.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the aggregated list of VM extension policies.
"etag": "A String",
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"items": { # A list of VmExtensionPoliciesScopedList resources.
"a_key": { # Name of the scope containing this set of VmExtensionPolicies.
"vmExtensionPolicies": [ # List of VmExtensionPolicy resources contained in this scope.
{ # Represents a VM extension policy.
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource.
"extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy
# configurations.
"a_key": { # Configuration for a specific VM extension.
"pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
# version is used.
"stringConfig": "A String", # Optional. String-based configuration data for the extension.
},
},
"globalResourceLink": "A String", # Optional. [Output Only] Link to the global policy that manages this zone policy, if
# applicable.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
# *any* of the provided selectors (logical OR). If this list is empty, the
# policy applies to all VMs.
{ # Defines how to select VMs to apply a zone VM extension policy.
"labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
# labels.
"inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
# VMs must have all of the labels specified in this map to be selected
# (logical AND).
#
# e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
# "value2")}, the VM labels must contain both ("key1", "value1") and
# ("key2", "value2") to be selected. If the VM labels are ("key1",
# "value1") and ("something", "else"), it will not be selected.
#
# If the map is empty, it's considered a match.
"a_key": "A String",
},
},
},
],
"kind": "compute#vmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
"managedByGlobal": True or False, # Optional. [Output Only] Indicates if this policy is managed by a global policy.
"name": "A String", # Name of the resource. Provided by the client when the resource is created.
# The name must be 1-63 characters long, and comply withRFC1035.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z]([-a-z0-9]*[a-z0-9])?`
# which means the first character must be a lowercase letter, and all
# following characters must be a dash, lowercase letter, or digit, except
# the last character, which cannot be a dash.
"priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
# apply to the same extension.
# The policy priority is an integer from 0 to 65535, inclusive. Lower
# integers indicate higher priorities. If you do not specify a priority when
# creating a rule, it is assigned a priority of 1000. If priorities are
# equal, the policy with the more recent creation timestamp takes precedence.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
"state": "A String", # Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.
"updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
# text format.
},
],
"warning": { # Informational warning which replaces the list of
# backend services when the list is empty.
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
},
},
"kind": "compute#VmExtensionPolicyAggregatedList", # [Output Only] Type of resource. Alwayscompute#VmExtensionPolicyAggregatedList for lists of
# VmExtensionPolicies.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
# list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
# the query parameter pageToken in the next list request.
# Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"unreachables": [ # [Output Only] Unreachable resources.
"A String",
],
"warning": { # [Output Only] Informational warning message.
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
}
aggregatedList_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
close()
Close httplib2 connections.
get(project, globalVmExtensionPolicy, x__xgafv=None)
Gets details of a global VM extension policy.
Args:
project: string, Project ID for this request. (required)
globalVmExtensionPolicy: string, Name of the GlobalVmExtensionPolicy resource to return. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message describing GlobalVmExtensionPolicy object.
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration.
# The key is the name of the extension.
"a_key": { # Policy for a single extension.
"pinnedVersion": "A String", # Optional. The version pinning for the extension.
# If empty, the extension will be installed with the latest version
# released by the extension producer.
"stringConfig": "A String", # Optional. String configuration. Any string payload that the extension
# understands.
},
},
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"instanceSelectors": [ # Optional. Selector to target VMs for a policy.
# There is a logical "AND" between instance_selectors.
{ # Selector to target VMs for a zone VM extension policy.
"labelSelector": { # A LabelSelector is applicable for a VM only if it matches all labels in # Optional. Labels within the LabelSelector are OR'd.
# the LabelSelector.
"inclusionLabels": { # Optional. Labels as key value pairs.
# A VM should contain all the pairs specified in this map to be selected;
# Labels within the LabelSelector are OR'ed.
"a_key": "A String",
},
},
},
],
"kind": "compute#globalVmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
"name": "A String", # Name of the resource. Provided by the client when the resource is created.
# The name must be 1-63 characters long, and comply withRFC1035.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z]([-a-z0-9]*[a-z0-9])?`
# which means the first character must be a lowercase letter, and all
# following characters must be a dash, lowercase letter, or digit, except
# the last character, which cannot be a dash.
"priority": 42, # Optional. Used to resolve conflicts when multiple policies are active for the same
# extension. Defaults to 0.
#
# Larger the number, higher the priority. When the priority is the same,
# the policy with the newer create time has higher priority.
"rolloutOperation": { # Represents the rollout operation # Required. The rollout strategy and status.
"rolloutInput": { # Required. The rollout input which defines the rollout plan.
"conflictBehavior": "A String", # Optional. [Optional] Specifies the behavior of the Rollout if a conflict is
# detected in a project during a Rollout. It can be one of the following
# values:
# 1) empty : don't overwrite the local value if conflict happens. This is
# the default behavior.
# 2) "overwrite" : Overwrite the local value with the rollout value.
# The concept of "conflict" applies to:
# 1) Insert action. If the zonal policy already exists when Insert
# happens, it's a conflict.
# 2) Update action. If the zonal policy was updated out of band by a
# zonal API, it's a conflict.
"name": "A String", # Optional. The name of the rollout plan.
# Ex.
# projects//locations/global/rolloutPlans/.
"predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan.
"retryUuid": "A String", # Optional. The UUID of the retry action. Only set it if this is a retry
# for an existing resource. This is for the user re-populate the resource
# without changes. An error will be returned if the retry_uuid is set but
# the resource get modified.
},
"rolloutStatus": { # [Output Only] The rollout status of the policy.
"currentRollouts": [ # [Output Only] The current rollouts for the latest version of the
# resource. There should be only one current rollout, but for
# scalability, we make it repeated.
{
"rollout": "A String", # [Output Only] The name of the rollout.
# Ex. projects//locations/global/rollouts/.
"rolloutPlan": "A String", # [Output Only] The name of the rollout plan.
# Ex.
# projects//locations/global/rolloutPlans/.
"state": "A String", # [Output Only] The overall state of the rollout.
},
],
"previousRollout": { # [Output Only] The last completed rollout resource. This field will not
# be populated until the first rollout is completed.
"rollout": "A String", # [Output Only] The name of the rollout.
# Ex. projects//locations/global/rollouts/.
"rolloutPlan": "A String", # [Output Only] The name of the rollout plan.
# Ex.
# projects//locations/global/rolloutPlans/.
"state": "A String", # [Output Only] The overall state of the rollout.
},
},
},
"scopedResourceStatus": "A String", # [Output Only] The scoped resource status. It's only for tracking the
# purging status of the policy.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
"updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
# text format.
}