Compute.Images.GetFromFamily (Compute Engine API v1 (Rev. 235) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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(java.lang.String project, java.lang.String family)` Returns the latest image that is part of an image family and is not deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getFamily()` Name of the image family to search for.
`java.lang.String`	`getProject()` Project ID for this request.
`Compute.Images.GetFromFamily`	`set(java.lang.String parameterName, java.lang.Object value)`
`Compute.Images.GetFromFamily`	`setAlt(java.lang.String alt)` Data format for the response.
`Compute.Images.GetFromFamily`	`setFamily(java.lang.String family)` Name of the image family to search for.
`Compute.Images.GetFromFamily`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Compute.Images.GetFromFamily`	`setKey(java.lang.String key)` API key.
`Compute.Images.GetFromFamily`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Compute.Images.GetFromFamily`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Compute.Images.GetFromFamily`	`setProject(java.lang.String project)` Project ID for this request.
`Compute.Images.GetFromFamily`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Compute.Images.GetFromFamily`	`setUserIp(java.lang.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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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(java.lang.String project,
                        java.lang.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 com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Image>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Image>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Compute.Images.GetFromFamily setAlt(java.lang.String alt)
```
    Description copied from class: ComputeRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class ComputeRequest<Image>
  - setFields
```
public Compute.Images.GetFromFamily setFields(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String userIp)
```
    Description copied from class: ComputeRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class ComputeRequest<Image>
  - getProject
```
public java.lang.String getProject()
```
    Project ID for this request.
  - setProject
```
public Compute.Images.GetFromFamily setProject(java.lang.String project)
```
    Project ID for this request.
  - getFamily
```
public java.lang.String getFamily()
```
    Name of the image family to search for.
  - setFamily
```
public Compute.Images.GetFromFamily setFamily(java.lang.String family)
```
    Name of the image family to search for.
  - set
```
public Compute.Images.GetFromFamily set(java.lang.String parameterName,
                                        java.lang.Object value)
```
    Overrides:
    
    set in class ComputeRequest<Image>

Compute Engine API v1 (revision 235)

Class Compute.Images.GetFromFamily

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GetFromFamily

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getProject

setProject

getFamily

setFamily

set