"title":"Google Compute Engine Instance Group Updater API",
"description":"[Deprecated. Please use compute.instanceGroupManagers.update method. replicapoolupdater API will be disabled after December 30th, 2016] Updates groups of Compute Engine instances.",
"description":"Selector specifying which fields to include in a partial response.",
"location":"query"
},
"key":{
"type":"string",
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location":"query"
},
"oauth_token":{
"type":"string",
"description":"OAuth 2.0 token for the current user.",
"location":"query"
},
"prettyPrint":{
"type":"boolean",
"description":"Returns response with indentations and line breaks.",
"default":"true",
"location":"query"
},
"quotaUser":{
"type":"string",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
"location":"query"
},
"userIp":{
"type":"string",
"description":"IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"description":"Errors that occurred during the instance update.",
"properties":{
"errors":{
"type":"array",
"description":"[Output Only] The array of errors encountered while processing this operation.",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"description":"[Output Only] The error type identifier for this error."
},
"location":{
"type":"string",
"description":"[Output Only] Indicates the field in the request that caused the error. This property is optional."
},
"message":{
"type":"string",
"description":"[Output Only] An optional, human-readable error message."
}
}
}
}
}
},
"instance":{
"type":"string",
"description":"Fully-qualified URL of the instance being updated."
},
"status":{
"type":"string",
"description":"Status of the instance update. Possible values are: \n- \"PENDING\": The instance update is pending execution. \n- \"ROLLING_FORWARD\": The instance update is going forward. \n- \"ROLLING_BACK\": The instance update is being rolled back. \n- \"PAUSED\": The instance update is temporarily paused (inactive). \n- \"ROLLED_OUT\": The instance update is finished, the instance is running the new template. \n- \"ROLLED_BACK\": The instance update is finished, the instance has been reverted to the previous template. \n- \"CANCELLED\": The instance update is paused and no longer can be resumed, undefined in which template the instance is running."
}
}
},
"InstanceUpdateList":{
"id":"InstanceUpdateList",
"type":"object",
"description":"Response returned by ListInstanceUpdates method.",
"properties":{
"items":{
"type":"array",
"description":"Collection of requested instance updates.",
"items":{
"$ref":"InstanceUpdate"
}
},
"kind":{
"type":"string",
"description":"[Output Only] Type of the resource.",
"default":"replicapoolupdater#instanceUpdateList"
},
"nextPageToken":{
"type":"string",
"description":"A token used to continue a truncated list request."
},
"selfLink":{
"type":"string",
"description":"[Output Only] The fully qualified URL for the resource."
}
}
},
"Operation":{
"id":"Operation",
"type":"object",
"description":"An operation resource, used to manage asynchronous API requests.",
"properties":{
"clientOperationId":{
"type":"string"
},
"creationTimestamp":{
"type":"string",
"description":"[Output Only] Creation timestamp in RFC3339 text format."
},
"endTime":{
"type":"string"
},
"error":{
"type":"object",
"description":"[Output Only] If errors occurred during processing of this operation, this field will be populated.",
"properties":{
"errors":{
"type":"array",
"description":"[Output Only] The array of errors encountered while processing this operation.",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"description":"[Output Only] The error type identifier for this error."
},
"location":{
"type":"string",
"description":"[Output Only] Indicates the field in the request that caused the error. This property is optional."
},
"message":{
"type":"string",
"description":"[Output Only] An optional, human-readable error message."
}
}
}
}
}
},
"httpErrorMessage":{
"type":"string"
},
"httpErrorStatusCode":{
"type":"integer",
"format":"int32"
},
"id":{
"type":"string",
"description":"[Output Only] Unique identifier for the resource; defined by the server.",
"format":"uint64"
},
"insertTime":{
"type":"string",
"description":"[Output Only] The time that this operation was requested. This is in RFC 3339 format."
},
"kind":{
"type":"string",
"description":"[Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.",
"default":"replicapoolupdater#operation"
},
"name":{
"type":"string",
"description":"[Output Only] Name of the resource."
},
"operationType":{
"type":"string"
},
"progress":{
"type":"integer",
"format":"int32"
},
"region":{
"type":"string",
"description":"[Output Only] URL of the region where the operation resides."
},
"selfLink":{
"type":"string",
"description":"[Output Only] The fully qualified URL for the resource."
},
"startTime":{
"type":"string",
"description":"[Output Only] The time that this operation was started by the server. This is in RFC 3339 format."
},
"status":{
"type":"string",
"description":"[Output Only] Status of the operation. Can be one of the following: \"PENDING\", \"RUNNING\", or \"DONE\"."
},
"statusMessage":{
"type":"string",
"description":"[Output Only] An optional textual description of the current status of the operation."
},
"targetId":{
"type":"string",
"description":"[Output Only] Unique target id which identifies a particular incarnation of the target.",
"format":"uint64"
},
"targetLink":{
"type":"string",
"description":"[Output Only] URL of the resource the operation is mutating."
},
"user":{
"type":"string"
},
"warnings":{
"type":"array",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"description":"[Output only] The warning type identifier for this warning."
},
"data":{
"type":"array",
"description":"[Output only] Metadata for this warning in key:value format.",
"items":{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"[Output Only] Metadata key for this warning."
},
"value":{
"type":"string",
"description":"[Output Only] Metadata value for this warning."
}
}
}
},
"message":{
"type":"string",
"description":"[Output only] Optional human-readable details for this warning."
}
}
}
},
"zone":{
"type":"string",
"description":"[Output Only] URL of the zone where the operation resides."
}
}
},
"OperationList":{
"id":"OperationList",
"type":"object",
"description":"Contains a list of Operation resources.",
"properties":{
"id":{
"type":"string",
"description":"[Output Only] Unique identifier for the resource; defined by the server."
},
"items":{
"type":"array",
"description":"[Output Only] The Operation resources.",
"items":{
"$ref":"Operation"
}
},
"kind":{
"type":"string",
"description":"[Output Only] Type of resource. Always replicapoolupdater#operationList for OperationList resources.",
"default":"replicapoolupdater#operationList"
},
"nextPageToken":{
"type":"string",
"description":"[Output Only] A token used to continue a truncate."
},
"selfLink":{
"type":"string",
"description":"[Output Only] The fully qualified URL for the resource."
}
}
},
"RollingUpdate":{
"id":"RollingUpdate",
"type":"object",
"description":"The following represents a resource describing a single update (rollout) of a group of instances to the given template.",
"properties":{
"actionType":{
"type":"string",
"description":"Specifies the action to take for each instance within the instance group. This can be RECREATE which will recreate each instance and is only available for managed instance groups. It can also be REBOOT which performs a soft reboot for each instance and is only available for regular (non-managed) instance groups."
},
"creationTimestamp":{
"type":"string",
"description":"[Output Only] Creation timestamp in RFC3339 text format."
},
"description":{
"type":"string",
"description":"An optional textual description of the resource; provided by the client when the resource is created."
},
"error":{
"type":"object",
"description":"[Output Only] Errors that occurred during the rolling update.",
"properties":{
"errors":{
"type":"array",
"description":"[Output Only] The array of errors encountered while processing this operation.",
"items":{
"type":"object",
"properties":{
"code":{
"type":"string",
"description":"[Output Only] The error type identifier for this error."
},
"location":{
"type":"string",
"description":"[Output Only] Indicates the field in the request that caused the error. This property is optional."
},
"message":{
"type":"string",
"description":"[Output Only] An optional, human-readable error message."
}
}
}
}
}
},
"id":{
"type":"string",
"description":"[Output Only] Unique identifier for the resource; defined by the server."
},
"instanceGroup":{
"type":"string",
"description":"Fully-qualified URL of an instance group being updated. Exactly one of instanceGroupManager and instanceGroup must be set."
},
"instanceGroupManager":{
"type":"string",
"description":"Fully-qualified URL of an instance group manager being updated. Exactly one of instanceGroupManager and instanceGroup must be set."
},
"instanceTemplate":{
"type":"string",
"description":"Fully-qualified URL of an instance template to apply."
},
"kind":{
"type":"string",
"description":"[Output Only] Type of the resource.",
"default":"replicapoolupdater#rollingUpdate"
},
"oldInstanceTemplate":{
"type":"string",
"description":"Fully-qualified URL of the instance template encountered while starting the update."
},
"policy":{
"type":"object",
"description":"Parameters of the update process.",
"properties":{
"autoPauseAfterInstances":{
"type":"integer",
"description":"Number of instances to update before the updater pauses the rolling update.",
"format":"int32"
},
"instanceStartupTimeoutSec":{
"type":"integer",
"description":"The maximum amount of time that the updater waits for a HEALTHY state after all of the update steps are complete. If the HEALTHY state is not received before the deadline, the instance update is considered a failure.",
"format":"int32"
},
"maxNumConcurrentInstances":{
"type":"integer",
"description":"The maximum number of instances that can be updated simultaneously. An instance update is considered complete only after the instance is restarted and initialized.",
"format":"int32"
},
"maxNumFailedInstances":{
"type":"integer",
"description":"The maximum number of instance updates that can fail before the group update is considered a failure. An instance update is considered failed if any of its update actions (e.g. Stop call on Instance resource in Rolling Reboot) failed with permanent failure, or if the instance is in an UNHEALTHY state after it finishes all of the update actions.",
"format":"int32"
},
"minInstanceUpdateTimeSec":{
"type":"integer",
"description":"The minimum amount of time that the updater spends to update each instance. Update time is the time it takes to complete all update actions (e.g. Stop call on Instance resource in Rolling Reboot), reboot, and initialize. If the instance update finishes early, the updater pauses for the remainder of the time before it starts the next instance update.",
"format":"int32"
}
}
},
"progress":{
"type":"integer",
"description":"[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the update will be complete. This number should be monotonically increasing as the update progresses.",
"format":"int32"
},
"selfLink":{
"type":"string",
"description":"[Output Only] The fully qualified URL for the resource."
},
"status":{
"type":"string",
"description":"[Output Only] Status of the update. Possible values are: \n- \"ROLLING_FORWARD\": The update is going forward. \n- \"ROLLING_BACK\": The update is being rolled back. \n- \"PAUSED\": The update is temporarily paused (inactive). \n- \"ROLLED_OUT\": The update is finished, all instances have been updated successfully. \n- \"ROLLED_BACK\": The update is finished, all instances have been reverted to the previous template. \n- \"CANCELLED\": The update is paused and no longer can be resumed, undefined how many instances are running in which template."
},
"statusMessage":{
"type":"string",
"description":"[Output Only] An optional textual description of the current status of the update."
},
"user":{
"type":"string",
"description":"[Output Only] User who requested the update, for example: user@example.com."
}
}
},
"RollingUpdateList":{
"id":"RollingUpdateList",
"type":"object",
"description":"Response returned by List method.",
"properties":{
"items":{
"type":"array",
"description":"Collection of requested updates.",
"items":{
"$ref":"RollingUpdate"
}
},
"kind":{
"type":"string",
"description":"[Output Only] Type of the resource.",
"default":"replicapoolupdater#rollingUpdateList"
},
"nextPageToken":{
"type":"string",
"description":"A token used to continue a truncated list request."
},
"selfLink":{
"type":"string",
"description":"[Output Only] The fully qualified URL for the resource."