GlobalVmExtensionPolicy

Message describing GlobalVmExtensionPolicy object.

JSON representation
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "updateTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "extensionPolicies": {
    string: {
      object (ExtensionPolicy)
    },
    ...
  },
  "instanceSelectors": [
    {
      object (InstanceSelector)
    }
  ],
  "priority": integer,
  "scopedResourceStatus": enum (ScopedResourceStatus),
  "rolloutOperation": {
    object (RolloutOperation)
  }
}
Fields
kind

string

Output only. Type of the resource. Always

compute#globalVmExtensionPolicy

for globalVmExtensionPolicies.

id

string (uint64 format)

Output only. The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

Output only. Creation timestamp in RFC3339 text format.

updateTimestamp

string

Output only. Update timestamp in RFC3339 text format.

name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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.

description

string

An optional description of this resource. Provide this property when you create the resource.

extensionPolicies

map (key: string, value: object (ExtensionPolicy))

Required. Map from extension (eg: "cloudops") to its policy configuration. The key is the name of the extension.

instanceSelectors[]

object (InstanceSelector)

Optional. Selector to target VMs for a policy. There is a logical "AND" between instanceSelectors.

priority

integer

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.

scopedResourceStatus

enum (ScopedResourceStatus)

Output only. The scoped resource status. It's only for tracking the purging status of the policy.

rolloutOperation

object (RolloutOperation)

Required. The rollout strategy and status.

ExtensionPolicy

Policy for a single extension.

JSON representation
{
  "pinnedVersion": string,

  // Union field config can be only one of the following:
  "stringConfig": string
  // End of list of possible types for union field config.
}
Fields
pinnedVersion

string

Optional. The version pinning for the extension. If empty, the extension will be installed with the latest version released by the extension producer.

Union field config. This is any additional payload handed off to the extension on every start request. Payload is optional and defined by the service and extension itself. config can be only one of the following:
stringConfig

string

Optional. String configuration. Any string payload that the extension understands.

InstanceSelector

Selector to target VMs for a zone VM extension policy.

JSON representation
{

  // Union field selector_type can be only one of the following:
  "labelSelector": {
    object (LabelSelector)
  }
  // End of list of possible types for union field selector_type.
}
Fields
Union field selector_type. Initially only LabelSelector is available. selector_type can be only one of the following:
labelSelector

object (LabelSelector)

Optional. Labels within the LabelSelector are OR'd.

LabelSelector

A LabelSelector is applicable for a VM only if it matches all labels in the LabelSelector.

JSON representation
{
  "inclusionLabels": {
    string: string,
    ...
  }
}
Fields
inclusionLabels

map (key: string, value: string)

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.

ScopedResourceStatus

Enums
SCOPED_RESOURCE_STATUS_UNSPECIFIED Default value. This value is unused.
SCOPED_RESOURCE_STATUS_DELETING The zonal policies are being deleted.

RolloutOperation

Represents the rollout operation

JSON representation
{
  "rolloutInput": {
    object (RolloutInput)
  },
  "rolloutStatus": {
    object (RolloutStatus)
  }
}
Fields
rolloutInput

object (RolloutInput)

Required. The rollout input which defines the rollout plan.

rolloutStatus

object (RolloutStatus)

Output only. The rollout status of the policy.

RolloutStatus

JSON representation
{
  "currentRollouts": [
    {
      object (RolloutMetadata)
    }
  ],
  "previousRollout": {
    object (RolloutMetadata)
  }
}
Fields
currentRollouts[]

object (RolloutMetadata)

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.

previousRollout

object (RolloutMetadata)

Output only. The last completed rollout resource. This field will not be populated until the first rollout is completed.

RolloutMetadata

JSON representation
{
  "rollout": string,
  "rolloutPlan": string,
  "state": enum (State),
  "locationRolloutStatus": {
    string: {
      object (LocationRolloutStatus)
    },
    ...
  }
}
Fields
rollout

string

Output only. The name of the rollout. Ex. projects//locations/global/rollouts/.

rolloutPlan

string

Output only. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.

state

enum (State)

Output only. The overall state of the rollout.

locationRolloutStatus

map (key: string, value: object (LocationRolloutStatus))

Output only. The rollout status for each location. The list of the locations is the same as the list of locations in the rollout plan.

State

Enums
STATE_UNSPECIFIED Default value. This value is unused.
STATE_PROCESSING Iteration is in progress.
STATE_COMPLETED Iteration completed, with all actions being successful.
STATE_FAILED Iteration completed, with failures.
STATE_CANCELLED Iteration was explicitly cancelled.
STATE_PAUSED The rollout is paused.
STATE_UNKNOWN Impossible to determine current state of the iteration.

LocationRolloutStatus

JSON representation
{
  "state": enum (LocationRolloutState)
}
Fields
state

enum (LocationRolloutState)

Output only. The state of the location rollout.

LocationRolloutState

Enums
LOCATION_ROLLOUT_STATE_UNSPECIFIED Default value. This value is unused.
LOCATION_ROLLOUT_STATE_NOT_STARTED The location rollout has not started.
LOCATION_ROLLOUT_STATE_COMPLETED The location rollout is completed.
LOCATION_ROLLOUT_STATE_FAILED The location rollout has failed.
LOCATION_ROLLOUT_STATE_SKIPPED The location rollout is skipped.