com.google.api.services.compute

Class Compute.Images.GetFromFamily

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.compute.ComputeRequest<Image>

com.google.api.services.compute.Compute.Images.GetFromFamily

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Images

public class Compute.Images.GetFromFamily
extends ComputeRequest<Image>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetFromFamily(String project, String family) Returns the latest image that is part of an image family and is not deprecated.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getFamily() Name of the image family to search for.
String	getProject() Project ID for this request.
Compute.Images.GetFromFamily	set(String parameterName, Object value)
Compute.Images.GetFromFamily	setAlt(String alt) Data format for the response.
Compute.Images.GetFromFamily	setFamily(String family) Name of the image family to search for.
Compute.Images.GetFromFamily	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.Images.GetFromFamily	setKey(String key) API key.
Compute.Images.GetFromFamily	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.Images.GetFromFamily	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Images.GetFromFamily	setProject(String project) Project ID for this request.
Compute.Images.GetFromFamily	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Compute.Images.GetFromFamily	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.compute.ComputeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GetFromFamily

protected GetFromFamily(String project,
                        String family)

Returns the latest image that is part of an image family and is not deprecated. Create a request for the method "images.getFromFamily". This request holds the parameters needed by the the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

GetFromFamily#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientR equest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

family - Name of the image family to search for.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Image>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Image>

Throws:

IOException

setAlt

public Compute.Images.GetFromFamily setAlt(String alt)

Description copied from class: ComputeRequest

Data format for the response.

Overrides:

setAlt in class ComputeRequest<Image>

setFields

public Compute.Images.GetFromFamily setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<Image>

setKey

public Compute.Images.GetFromFamily setKey(String key)

Description copied from class: ComputeRequest

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.

Overrides:

setKey in class ComputeRequest<Image>

setOauthToken

public Compute.Images.GetFromFamily setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<Image>

setPrettyPrint

public Compute.Images.GetFromFamily setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Image>

setQuotaUser

public Compute.Images.GetFromFamily setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ComputeRequest<Image>

setUserIp

public Compute.Images.GetFromFamily setUserIp(String userIp)

Description copied from class: ComputeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ComputeRequest<Image>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Images.GetFromFamily setProject(String project)

Project ID for this request.

getFamily

public String getFamily()

Name of the image family to search for.

setFamily

public Compute.Images.GetFromFamily setFamily(String family)

Name of the image family to search for.

set

public Compute.Images.GetFromFamily set(String parameterName,
                                        Object value)

Overrides:

set in class ComputeRequest<Image>