ComputeRequest (Compute Engine API v1 (Rev. 101) 1.21.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<T>

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

Compute.Addresses.AggregatedList, Compute.Addresses.Delete, Compute.Addresses.Get, Compute.Addresses.Insert, Compute.Addresses.List, Compute.Autoscalers.AggregatedList, Compute.Autoscalers.Delete, Compute.Autoscalers.Get, Compute.Autoscalers.Insert, Compute.Autoscalers.List, Compute.Autoscalers.Patch, Compute.Autoscalers.Update, Compute.BackendServices.Delete, Compute.BackendServices.Get, Compute.BackendServices.GetHealth, Compute.BackendServices.Insert, Compute.BackendServices.List, Compute.BackendServices.Patch, Compute.BackendServices.Update, Compute.Disks.AggregatedList, Compute.Disks.CreateSnapshot, Compute.Disks.Delete, Compute.Disks.Get, Compute.Disks.Insert, Compute.Disks.List, Compute.DiskTypes.AggregatedList, Compute.DiskTypes.Get, Compute.DiskTypes.List, Compute.Firewalls.Delete, Compute.Firewalls.Get, Compute.Firewalls.Insert, Compute.Firewalls.List, Compute.Firewalls.Patch, Compute.Firewalls.Update, Compute.ForwardingRules.AggregatedList, Compute.ForwardingRules.Delete, Compute.ForwardingRules.Get, Compute.ForwardingRules.Insert, Compute.ForwardingRules.List, Compute.ForwardingRules.SetTarget, Compute.GlobalAddresses.Delete, Compute.GlobalAddresses.Get, Compute.GlobalAddresses.Insert, Compute.GlobalAddresses.List, Compute.GlobalForwardingRules.Delete, Compute.GlobalForwardingRules.Get, Compute.GlobalForwardingRules.Insert, Compute.GlobalForwardingRules.List, Compute.GlobalForwardingRules.SetTarget, Compute.GlobalOperations.AggregatedList, Compute.GlobalOperations.Delete, Compute.GlobalOperations.Get, Compute.GlobalOperations.List, Compute.HttpHealthChecks.Delete, Compute.HttpHealthChecks.Get, Compute.HttpHealthChecks.Insert, Compute.HttpHealthChecks.List, Compute.HttpHealthChecks.Patch, Compute.HttpHealthChecks.Update, Compute.HttpsHealthChecks.Delete, Compute.HttpsHealthChecks.Get, Compute.HttpsHealthChecks.Insert, Compute.HttpsHealthChecks.List, Compute.HttpsHealthChecks.Patch, Compute.HttpsHealthChecks.Update, Compute.Images.Delete, Compute.Images.Deprecate, Compute.Images.Get, Compute.Images.Insert, Compute.Images.List, Compute.InstanceGroupManagers.AbandonInstances, Compute.InstanceGroupManagers.AggregatedList, Compute.InstanceGroupManagers.Delete, Compute.InstanceGroupManagers.DeleteInstances, Compute.InstanceGroupManagers.Get, Compute.InstanceGroupManagers.Insert, Compute.InstanceGroupManagers.List, Compute.InstanceGroupManagers.ListManagedInstances, Compute.InstanceGroupManagers.RecreateInstances, Compute.InstanceGroupManagers.Resize, Compute.InstanceGroupManagers.SetInstanceTemplate, Compute.InstanceGroupManagers.SetTargetPools, Compute.InstanceGroups.AddInstances, Compute.InstanceGroups.AggregatedList, Compute.InstanceGroups.Delete, Compute.InstanceGroups.Get, Compute.InstanceGroups.Insert, Compute.InstanceGroups.List, Compute.InstanceGroups.ListInstances, Compute.InstanceGroups.RemoveInstances, Compute.InstanceGroups.SetNamedPorts, Compute.Instances.AddAccessConfig, Compute.Instances.AggregatedList, Compute.Instances.AttachDisk, Compute.Instances.Delete, Compute.Instances.DeleteAccessConfig, Compute.Instances.DetachDisk, Compute.Instances.Get, Compute.Instances.GetSerialPortOutput, Compute.Instances.Insert, Compute.Instances.List, Compute.Instances.Reset, Compute.Instances.SetDiskAutoDelete, Compute.Instances.SetMachineType, Compute.Instances.SetMetadata, Compute.Instances.SetScheduling, Compute.Instances.SetTags, Compute.Instances.Start, Compute.Instances.Stop, Compute.InstanceTemplates.Delete, Compute.InstanceTemplates.Get, Compute.InstanceTemplates.Insert, Compute.InstanceTemplates.List, Compute.Licenses.Get, Compute.MachineTypes.AggregatedList, Compute.MachineTypes.Get, Compute.MachineTypes.List, Compute.Networks.Delete, Compute.Networks.Get, Compute.Networks.Insert, Compute.Networks.List, Compute.Projects.Get, Compute.Projects.MoveDisk, Compute.Projects.MoveInstance, Compute.Projects.SetCommonInstanceMetadata, Compute.Projects.SetUsageExportBucket, Compute.RegionOperations.Delete, Compute.RegionOperations.Get, Compute.RegionOperations.List, Compute.Regions.Get, Compute.Regions.List, Compute.Routes.Delete, Compute.Routes.Get, Compute.Routes.Insert, Compute.Routes.List, Compute.Snapshots.Delete, Compute.Snapshots.Get, Compute.Snapshots.List, Compute.SslCertificates.Delete, Compute.SslCertificates.Get, Compute.SslCertificates.Insert, Compute.SslCertificates.List, Compute.Subnetworks.AggregatedList, Compute.Subnetworks.Delete, Compute.Subnetworks.Get, Compute.Subnetworks.Insert, Compute.Subnetworks.List, Compute.TargetHttpProxies.Delete, Compute.TargetHttpProxies.Get, Compute.TargetHttpProxies.Insert, Compute.TargetHttpProxies.List, Compute.TargetHttpProxies.SetUrlMap, Compute.TargetHttpsProxies.Delete, Compute.TargetHttpsProxies.Get, Compute.TargetHttpsProxies.Insert, Compute.TargetHttpsProxies.List, Compute.TargetHttpsProxies.SetSslCertificates, Compute.TargetHttpsProxies.SetUrlMap, Compute.TargetInstances.AggregatedList, Compute.TargetInstances.Delete, Compute.TargetInstances.Get, Compute.TargetInstances.Insert, Compute.TargetInstances.List, Compute.TargetPools.AddHealthCheck, Compute.TargetPools.AddInstance, Compute.TargetPools.AggregatedList, Compute.TargetPools.Delete, Compute.TargetPools.Get, Compute.TargetPools.GetHealth, Compute.TargetPools.Insert, Compute.TargetPools.List, Compute.TargetPools.RemoveHealthCheck, Compute.TargetPools.RemoveInstance, Compute.TargetPools.SetBackup, Compute.TargetVpnGateways.AggregatedList, Compute.TargetVpnGateways.Delete, Compute.TargetVpnGateways.Get, Compute.TargetVpnGateways.Insert, Compute.TargetVpnGateways.List, Compute.UrlMaps.Delete, Compute.UrlMaps.Get, Compute.UrlMaps.Insert, Compute.UrlMaps.List, Compute.UrlMaps.Patch, Compute.UrlMaps.Update, Compute.UrlMaps.Validate, Compute.VpnTunnels.AggregatedList, Compute.VpnTunnels.Delete, Compute.VpnTunnels.Get, Compute.VpnTunnels.Insert, Compute.VpnTunnels.List, Compute.ZoneOperations.Delete, Compute.ZoneOperations.Get, Compute.ZoneOperations.List, Compute.Zones.Get, Compute.Zones.List
```
public abstract class ComputeRequest<T>
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
```
Compute request.

Since:

1.3

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
Constructor and Description
`ComputeRequest(Compute client, java.lang.String method, java.lang.String uriTemplate, java.lang.Object content, java.lang.Class<T> responseClass)`

Method Summary

Methods
Modifier and Type	Method and Description
`Compute`	`getAbstractGoogleClient()`
`java.lang.String`	`getAlt()` Data format for the response.
`java.lang.String`	`getFields()` Selector specifying which fields to include in a partial response.
`java.lang.String`	`getKey()` API key.
`java.lang.String`	`getOauthToken()` OAuth 2.0 token for the current user.
`java.lang.Boolean`	`getPrettyPrint()` Returns response with indentations and line breaks.
`java.lang.String`	`getQuotaUser()` Available to use for quota purposes for server-side applications.
`java.lang.String`	`getUserIp()` IP address of the site where the request originates.
`ComputeRequest<T>`	`set(java.lang.String parameterName, java.lang.Object value)`
`ComputeRequest<T>`	`setAlt(java.lang.String alt)` Data format for the response.
`ComputeRequest<T>`	`setDisableGZipContent(boolean disableGZipContent)`
`ComputeRequest<T>`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`ComputeRequest<T>`	`setKey(java.lang.String key)` API key.
`ComputeRequest<T>`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`ComputeRequest<T>`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`ComputeRequest<T>`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`ComputeRequest<T>`	`setRequestHeaders(com.google.api.client.http.HttpHeaders headers)`
`ComputeRequest<T>`	`setUserIp(java.lang.String userIp)` IP address of the site where the request originates.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

- Constructor Detail
  - ComputeRequest
```
public ComputeRequest(Compute client,
              java.lang.String method,
              java.lang.String uriTemplate,
              java.lang.Object content,
              java.lang.Class<T> responseClass)
```
    Parameters:
    client - Google client
    method - HTTP Method
    uriTemplate - URI template for the path relative to the base URL. If it starts with a "/" the base path from the base URL will be stripped out. The URI template can also be a full URL. URI template expansion is done using UriTemplate.expand(String, String, Object, boolean)
    content - A POJO that can be serialized into JSON or null for none
    responseClass - response class to parse into
- Method Detail
  - getAlt
```
public java.lang.String getAlt()
```
    Data format for the response. [default: json]
  - setAlt
```
public ComputeRequest<T> setAlt(java.lang.String alt)
```
    Data format for the response.
  - getFields
```
public java.lang.String getFields()
```
    Selector specifying which fields to include in a partial response.
  - setFields
```
public ComputeRequest<T> setFields(java.lang.String fields)
```
    Selector specifying which fields to include in a partial response.
  - getKey
```
public java.lang.String getKey()
```
    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.
  - setKey
```
public ComputeRequest<T> setKey(java.lang.String key)
```
    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.
  - getOauthToken
```
public java.lang.String getOauthToken()
```
    OAuth 2.0 token for the current user.
  - setOauthToken
```
public ComputeRequest<T> setOauthToken(java.lang.String oauthToken)
```
    OAuth 2.0 token for the current user.
  - getPrettyPrint
```
public java.lang.Boolean getPrettyPrint()
```
    Returns response with indentations and line breaks. [default: true]
  - setPrettyPrint
```
public ComputeRequest<T> setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Returns response with indentations and line breaks.
  - getQuotaUser
```
public java.lang.String getQuotaUser()
```
    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.
  - setQuotaUser
```
public ComputeRequest<T> setQuotaUser(java.lang.String quotaUser)
```
    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.
  - getUserIp
```
public java.lang.String getUserIp()
```
    IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  - setUserIp
```
public ComputeRequest<T> setUserIp(java.lang.String userIp)
```
    IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  - getAbstractGoogleClient
```
public final Compute getAbstractGoogleClient()
```
    Overrides:
    
    getAbstractGoogleClient in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
  - setDisableGZipContent
```
public ComputeRequest<T> setDisableGZipContent(boolean disableGZipContent)
```
    Overrides:
    
    setDisableGZipContent in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
  - setRequestHeaders
```
public ComputeRequest<T> setRequestHeaders(com.google.api.client.http.HttpHeaders headers)
```
    Overrides:
    
    setRequestHeaders in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
  - set
```
public ComputeRequest<T> set(java.lang.String parameterName,
                    java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

Compute Engine API v1 (revision 101)

Class ComputeRequest<T>

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.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

Constructor Detail

ComputeRequest

Method Detail

getAlt

setAlt

getFields

setFields

getKey

setKey

getOauthToken

setOauthToken

getPrettyPrint

setPrettyPrint

getQuotaUser

setQuotaUser

getUserIp

setUserIp

getAbstractGoogleClient

setDisableGZipContent

setRequestHeaders

set