in providers/google-compute-engine/src/main/java/org/jclouds/googlecomputeengine/features/InstanceApi.java [107:333]
Operation addAccessConfigToNic(@PathParam("instance") String instance,
@BinderParam(BindToJsonPayload.class)
AccessConfig accessConfig,
@QueryParam("networkInterface") String networkInterfaceName);
/**
* Deletes an access config from an instance's network interface.
*
* @param instance the instance name.
* @param accessConfigName the name of the access config to delete
* @param networkInterfaceName network interface name.
* @return an Operation resource. To check on the status of an operation, poll the Operations resource returned to
* you, and look for the status field.
*/
@Named("Instances:deleteAccessConfig")
@POST
@Path("/{instance}/deleteAccessConfig")
Operation deleteAccessConfigFromNic(@PathParam("instance") String instance,
@QueryParam("accessConfig") String accessConfigName,
@QueryParam("networkInterface") String networkInterfaceName);
/**
* Returns the specified instance's serial port output.
*
* @param instance the instance name.
* @return if successful, this method returns a SerialPortOutput containing the instance's serial output.
*/
@Named("Instances:getSerialPortOutput")
@GET
@Path("/{instance}/serialPort")
SerialPortOutput getSerialPortOutput(@PathParam("instance") String instance);
/**
* Returns the specified instance's serial port output.
*
* @param instance the instance name.
* @return if successful, this method returns a SerialPortOutput containing the instance's serial output.
*/
@Named("Instances:getSerialPortOutput")
@GET
@Path("/{instance}/serialPort")
SerialPortOutput getSerialPortOutput(@PathParam("instance") String instance, @QueryParam("port") int port);
/**
* Hard-resets the instance.
*
* @param instance the instance name
* @return an Operation resource. To check on the status of an operation, poll the Operations resource returned to
* you, and look for the status field.
*/
@Named("Instances:reset")
@POST
@Path("/{instance}/reset")
Operation reset(@PathParam("instance") String instance);
/**
* Attaches a disk to an instance
*
* @param instance The instance name to attach to
* @param attachDiskOptions The options for attaching the disk.
*
* @return an Operation resource. To check on the status of an operation, poll the Operations resource returned to
* you, and look for the status field.
*/
@Named("Instances:attachDisk")
@POST
@Produces(APPLICATION_JSON)
@Path("/{instance}/attachDisk")
Operation attachDisk(@PathParam("instance") String instance,
@BinderParam(BindToJsonPayload.class) AttachDisk attachDiskOptions);
/**
* Detaches an attached disk from an instance
*
* @param instance The instance name to attach to
* @param deviceName The device name of the disk to detach.
*
* @return an Operation resource. To check on the status of an operation, poll the Operations resource returned to
* you, and look for the status field.
*/
@Named("Instances:detachDisk")
@POST
@Path("/{instance}/detachDisk")
Operation detachDisk(@PathParam("instance") String instance, @QueryParam("deviceName") String deviceName);
/**
* Sets metadata for an instance using the data included in the request.
* <p/>
* NOTE: This *sets* metadata items on the project (vs *adding* items to metadata),
* if there are existing metadata that must be kept these must be fetched first and then re-sent on update.
* <pre><tt>
* Metadata update = instanceApi.get("myInstance").metadata().clone();
* update.put("newItem","newItemValue");
* instanceApi.setMetadata("myInstance", update);
* </tt></pre>
*
* @param instance The name of the instance
* @param metadata the metadata to set
*
* @return an Operations resource. To check on the status of an operation, poll the Operations resource returned
* to you, and look for the status field.
*/
@Named("Instances:setMetadata")
@POST
@Path("/{instance}/setMetadata")
Operation setMetadata(@PathParam("instance") String instance,
@BinderParam(BindToJsonPayload.class) Metadata metadata);
/**
* Lists items for an instance
*
* @param instance the name of the instance
* @param items A set of items
* @param fingerprint The current fingerprint for the items
* @return an Operations resource. To check on the status of an operation, poll the Operations resource returned
* to you, and look for the status field.
*/
@Named("Instances:setTags")
@POST
@Path("/{instance}/setTags")
@Produces(APPLICATION_JSON)
@MapBinder(BindToJsonPayload.class)
Operation setTags(@PathParam("instance") String instance,
@PayloadParam("items") Iterable<String> items,
@PayloadParam("fingerprint") String fingerprint);
/**
* Sets the auto-delete flag for a disk attached to an instance
*
* @param instanceName The name of the instance
* @param deviceName Disk device name to modify.
* @param autoDelete Whether to auto-delete the disk when the instance is deleted
*/
@Named("Instances:setDiskAutoDelete")
@POST
@Path("/{instance}/setDiskAutoDelete")
Operation setDiskAutoDelete(@PathParam("instance") String instanceName,
@QueryParam("deviceName") String deviceName,
@QueryParam("autoDelete") boolean autoDelete);
/**
* Sets an instance's scheduling options.
* @see <a href = "https://cloud.google.com/compute/docs/instances#onhostmaintenance"/>
*
* @param instanceName The name of the instance
* @param onHostMaintenance either MIGRATE or TERMINATE the default is MIGRATE (Live Migration).
* @param automaticRestart Defines whether the Instance should be automatically
* restarted when it is terminated by Compute Engine (not terminated by user).
* Used when onHostMaintenance is set to TERMINATE.
* @param preemptible Defines whether the Instance should be launched as spot instance
* @return
*/
@Named("Instances:setScheduling")
@POST
@Path("/{instance}/setScheduling")
@MapBinder(BindToJsonPayload.class)
Operation setScheduling(@PathParam("instance") String instanceName,
@PayloadParam("onHostMaintenance") Scheduling.OnHostMaintenance onHostMaintenance,
@PayloadParam("automaticRestart") boolean automaticRestart,
@PayloadParam("preemptible") boolean preemptible);
/**
* This method starts an instance that was stopped using the using the {@link #stop(String)} method.
* @param instance - name of the instance to be started
*/
@Named("Instances:start")
@POST
@Path("/{instance}/start")
@Produces(APPLICATION_JSON)
Operation start(@PathParam("instance") String instance);
/**
* This method stops a running instance, shutting it down cleanly, and allows you to restart
* the instance at a later time. Stopped instances do not incur per-minute, virtual machine
* usage charges while they are stopped, but any resources that the virtual machine is using,
* such as persistent disks and static IP addresses,will continue to be charged until they are deleted.
* @param instance
* @return
*/
@Named("Instances:stop")
@POST
@Path("/{instance}/stop")
@Produces(APPLICATION_JSON)
Operation stop(@PathParam("instance") String instance);
/**
* Retrieves the list of instance resources available to the specified project.
* By default the list as a maximum size of 100, if no options are provided or ListOptions#getMaxResults() has not
* been set.
*
* @param pageToken marks the beginning of the next list page
* @param listOptions listing options
* @return a page of the list
*/
@Named("Instances:list")
@GET
ListPage<Instance> listPage(@Nullable @QueryParam("pageToken") String pageToken, ListOptions listOptions);
/** @see #listPage(String, ListOptions) */
@Named("Instances:list")
@GET
@Transform(InstancePages.class)
Iterator<ListPage<Instance>> list();
/** @see #listPage(String, ListOptions) */
@Named("Instances:list")
@GET
@Transform(InstancePages.class)
Iterator<ListPage<Instance>> list(ListOptions options);
static final class InstancePages extends BaseCallerArg0ToIteratorOfListPage<Instance, InstancePages> {
private final GoogleComputeEngineApi api;
@Inject InstancePages(GoogleComputeEngineApi api) {
this.api = api;
}
@Override
protected Function<String, ListPage<Instance>> fetchNextPage(final String zoneName, final ListOptions options) {
return new Function<String, ListPage<Instance>>() {
@Override public ListPage<Instance> apply(String pageToken) {
return api.instancesInZone(zoneName).listPage(pageToken, options);
}
};
}
}