com.google.api.services.compute

Class Compute.Hosts.Get

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

com.google.api.services.compute.Compute.Hosts.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Hosts

public class Compute.Hosts.Get
extends ComputeRequest<Host>

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

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(String project, String zone, String association, String host) Retrieves information about the specified host.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getAssociation() The parent resource association for the Host.
String	getHost() The name of the host, formatted as RFC1035 or a resource ID number.
String	getProject() The project ID for this request.
String	getZone() The name of the zone for this request, formatted as RFC1035.
Compute.Hosts.Get	set(String parameterName, Object value)
Compute.Hosts.Get	set$Xgafv(String $Xgafv) V1 error format.
Compute.Hosts.Get	setAccessToken(String accessToken) OAuth access token.
Compute.Hosts.Get	setAlt(String alt) Data format for response.
Compute.Hosts.Get	setAssociation(String association) The parent resource association for the Host.
Compute.Hosts.Get	setCallback(String callback) JSONP
Compute.Hosts.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.Hosts.Get	setHost(String host) The name of the host, formatted as RFC1035 or a resource ID number.
Compute.Hosts.Get	setKey(String key) API key.
Compute.Hosts.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.Hosts.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Hosts.Get	setProject(String project) The project ID for this request.
Compute.Hosts.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.Hosts.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.Hosts.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.Hosts.Get	setUserIp(String userIp) Legacy name for parameter that has been superseded by `quotaUser`.
Compute.Hosts.Get	setZone(String zone) The name of the zone for this request, formatted as RFC1035.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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

Get

protected Get(String project,
              String zone,
              String association,
              String host)

Retrieves information about the specified host. Create a request for the method "hosts.get". 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.

Compute.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - The project ID for this request.

zone - The name of the zone for this request, formatted as RFC1035.

association - The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host. For example, reservations/reservation_name, reservations/reservation_name/reservationBlocks/reservation_block_name or reservations/res ervation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_su b_block_name.

host - The name of the host, formatted as RFC1035 or a resource ID number.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Host>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Host>

Throws:

IOException

set$Xgafv

public Compute.Hosts.Get set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<Host>

setAccessToken

public Compute.Hosts.Get setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<Host>

setAlt

public Compute.Hosts.Get setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<Host>

setCallback

public Compute.Hosts.Get setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<Host>

setFields

public Compute.Hosts.Get setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<Host>

setKey

public Compute.Hosts.Get 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<Host>

setOauthToken

public Compute.Hosts.Get setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<Host>

setPrettyPrint

public Compute.Hosts.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Host>

setQuotaUser

public Compute.Hosts.Get setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

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:

setQuotaUser in class ComputeRequest<Host>

setUploadType

public Compute.Hosts.Get setUploadType(String uploadType)

Description copied from class: ComputeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ComputeRequest<Host>

setUploadProtocol

public Compute.Hosts.Get setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ComputeRequest<Host>

setUserIp

public Compute.Hosts.Get setUserIp(String userIp)

Description copied from class: ComputeRequest

Legacy name for parameter that has been superseded by `quotaUser`.

Overrides:

setUserIp in class ComputeRequest<Host>

getProject

public String getProject()

The project ID for this request.

setProject

public Compute.Hosts.Get setProject(String project)

The project ID for this request.

getZone

public String getZone()

The name of the zone for this request, formatted as RFC1035.

setZone

public Compute.Hosts.Get setZone(String zone)

The name of the zone for this request, formatted as RFC1035.

getAssociation

public String getAssociation()

The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host. For example, reservations/reservation_name, reservations/reservation_name/reservationBlocks/reservation_block_name or reservations/reservation_ name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.

setAssociation

public Compute.Hosts.Get setAssociation(String association)

The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host. For example, reservations/reservation_name, reservations/reservation_name/reservationBlocks/reservation_block_name or reservations/rese rvation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_ block_name.

getHost

public String getHost()

The name of the host, formatted as RFC1035 or a resource ID number.

setHost

public Compute.Hosts.Get setHost(String host)

The name of the host, formatted as RFC1035 or a resource ID number.

set

public Compute.Hosts.Get set(String parameterName,
                             Object value)

Overrides:

set in class ComputeRequest<Host>