Storage.Objects.Get (Cloud Storage JSON API v1-rev20210127-1.32.1)

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.storage.StorageRequest<StorageObject>
        
        com.google.api.services.storage.Storage.Objects.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects
```
public class Storage.Objects.Get
extends StorageRequest<StorageObject>
```

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 Get(String bucket, String object__)
Retrieves an object or its metadata.

Constructors
Modifier	Constructor and Description
`protected`	`Get(String bucket, String object__)` Retrieves an object or its metadata.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenericUrl`	`buildHttpRequestUrl()`
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeMedia()`
`void`	`executeMediaAndDownloadTo(OutputStream outputStream)`
`InputStream`	`executeMediaAsInputStream()`
`HttpResponse`	`executeUsingHead()`
`String`	`getBucket()` Name of the bucket in which the object resides.
`Long`	`getGeneration()` If present, selects a specific revision of this object (as opposed to the latest version, the default).
`Long`	`getIfGenerationMatch()` Makes the operation conditional on whether the object's current generation matches the given value.
`Long`	`getIfGenerationNotMatch()` Makes the operation conditional on whether the object's current generation does not match the given value.
`Long`	`getIfMetagenerationMatch()` Makes the operation conditional on whether the object's current metageneration matches the given value.
`Long`	`getIfMetagenerationNotMatch()` Makes the operation conditional on whether the object's current metageneration does not match the given value.
`String`	`getObject()` Name of the object.
`String`	`getProjection()` Set of properties to return.
`String`	`getProvisionalUserProject()` The project to be billed for this request if the target bucket is requester-pays bucket.
`String`	`getUserProject()` The project to be billed for this request.
`Storage.Objects.Get`	`set(String parameterName, Object value)`
`Storage.Objects.Get`	`setAlt(String alt)` Data format for the response.
`Storage.Objects.Get`	`setBucket(String bucket)` Name of the bucket in which the object resides.
`Storage.Objects.Get`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Objects.Get`	`setGeneration(Long generation)` If present, selects a specific revision of this object (as opposed to the latest version, the default).
`Storage.Objects.Get`	`setIfGenerationMatch(Long ifGenerationMatch)` Makes the operation conditional on whether the object's current generation matches the given value.
`Storage.Objects.Get`	`setIfGenerationNotMatch(Long ifGenerationNotMatch)` Makes the operation conditional on whether the object's current generation does not match the given value.
`Storage.Objects.Get`	`setIfMetagenerationMatch(Long ifMetagenerationMatch)` Makes the operation conditional on whether the object's current metageneration matches the given value.
`Storage.Objects.Get`	`setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)` Makes the operation conditional on whether the object's current metageneration does not match the given value.
`Storage.Objects.Get`	`setKey(String key)` API key.
`Storage.Objects.Get`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Storage.Objects.Get`	`setObject(String object__)` Name of the object.
`Storage.Objects.Get`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storage.Objects.Get`	`setProjection(String projection)` Set of properties to return.
`Storage.Objects.Get`	`setProvisionalUserProject(String provisionalUserProject)` The project to be billed for this request if the target bucket is requester-pays bucket.
`Storage.Objects.Get`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Storage.Objects.Get`	`setUserIp(String userIp)` Deprecated.
`Storage.Objects.Get`	`setUserProject(String userProject)` The project to be billed for this request.

Methods inherited from class com.google.api.services.storage.StorageRequest
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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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 bucket,
              String object__)
```
    Retrieves an object or its metadata. Create a request for the method "objects.get". This request holds the parameters needed by the the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Storage.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    bucket - Name of the bucket in which the object resides.
    
    object__ - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
    
    Since:
    
    1.13
- Method Detail
  - executeMediaAndDownloadTo
```
public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException
```
    Overrides:
    
    executeMediaAndDownloadTo in class AbstractGoogleClientRequest<StorageObject>
    
    Throws:
    
    IOException
  - executeMediaAsInputStream
```
public InputStream executeMediaAsInputStream()
                                      throws IOException
```
    Overrides:
    
    executeMediaAsInputStream in class AbstractGoogleClientRequest<StorageObject>
    
    Throws:
    
    IOException
  - executeMedia
```
public HttpResponse executeMedia()
                          throws IOException
```
    Overrides:
    
    executeMedia in class AbstractGoogleClientRequest<StorageObject>
    
    Throws:
    
    IOException
  - buildHttpRequestUrl
```
public GenericUrl buildHttpRequestUrl()
```
    Overrides:
    
    buildHttpRequestUrl in class AbstractGoogleClientRequest<StorageObject>
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<StorageObject>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<StorageObject>
    
    Throws:
    
    IOException
  - setAlt
```
public Storage.Objects.Get setAlt(String alt)
```
    Description copied from class: StorageRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class StorageRequest<StorageObject>
  - setFields
```
public Storage.Objects.Get setFields(String fields)
```
    Description copied from class: StorageRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class StorageRequest<StorageObject>
  - setKey
```
public Storage.Objects.Get setKey(String key)
```
    Description copied from class: StorageRequest
    
    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 StorageRequest<StorageObject>
  - setOauthToken
```
public Storage.Objects.Get setOauthToken(String oauthToken)
```
    Description copied from class: StorageRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class StorageRequest<StorageObject>
  - setPrettyPrint
```
public Storage.Objects.Get setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: StorageRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class StorageRequest<StorageObject>
  - setQuotaUser
```
public Storage.Objects.Get setQuotaUser(String quotaUser)
```
    Description copied from class: StorageRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class StorageRequest<StorageObject>
  - setUserIp
```
public Storage.Objects.Get setUserIp(String userIp)
```
    Description copied from class: StorageRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class StorageRequest<StorageObject>
  - getBucket
```
public String getBucket()
```
    Name of the bucket in which the object resides.
  - setBucket
```
public Storage.Objects.Get setBucket(String bucket)
```
    Name of the bucket in which the object resides.
  - getObject
```
public String getObject()
```
    Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  - setObject
```
public Storage.Objects.Get setObject(String object__)
```
    Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  - getGeneration
```
public Long getGeneration()
```
    If present, selects a specific revision of this object (as opposed to the latest version, the default).
  - setGeneration
```
public Storage.Objects.Get setGeneration(Long generation)
```
    If present, selects a specific revision of this object (as opposed to the latest version, the default).
  - getIfGenerationMatch
```
public Long getIfGenerationMatch()
```
    Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
  - setIfGenerationMatch
```
public Storage.Objects.Get setIfGenerationMatch(Long ifGenerationMatch)
```
    Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
  - getIfGenerationNotMatch
```
public Long getIfGenerationNotMatch()
```
    Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
  - setIfGenerationNotMatch
```
public Storage.Objects.Get setIfGenerationNotMatch(Long ifGenerationNotMatch)
```
    Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
  - getIfMetagenerationMatch
```
public Long getIfMetagenerationMatch()
```
    Makes the operation conditional on whether the object's current metageneration matches the given value.
  - setIfMetagenerationMatch
```
public Storage.Objects.Get setIfMetagenerationMatch(Long ifMetagenerationMatch)
```
    Makes the operation conditional on whether the object's current metageneration matches the given value.
  - getIfMetagenerationNotMatch
```
public Long getIfMetagenerationNotMatch()
```
    Makes the operation conditional on whether the object's current metageneration does not match the given value.
  - setIfMetagenerationNotMatch
```
public Storage.Objects.Get setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)
```
    Makes the operation conditional on whether the object's current metageneration does not match the given value.
  - getProjection
```
public String getProjection()
```
    Set of properties to return. Defaults to noAcl.
  - setProjection
```
public Storage.Objects.Get setProjection(String projection)
```
    Set of properties to return. Defaults to noAcl.
  - getProvisionalUserProject
```
public String getProvisionalUserProject()
```
    The project to be billed for this request if the target bucket is requester-pays bucket.
  - setProvisionalUserProject
```
public Storage.Objects.Get setProvisionalUserProject(String provisionalUserProject)
```
    The project to be billed for this request if the target bucket is requester-pays bucket.
  - getUserProject
```
public String getUserProject()
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - setUserProject
```
public Storage.Objects.Get setUserProject(String userProject)
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - set
```
public Storage.Objects.Get set(String parameterName,
                               Object value)
```
    Overrides:
    
    set in class StorageRequest<StorageObject>

Class Storage.Objects.Get

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

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

Get

Method Detail

executeMediaAndDownloadTo

executeMediaAsInputStream

executeMedia

buildHttpRequestUrl

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getBucket

setBucket

getObject

setObject

getGeneration

setGeneration

getIfGenerationMatch

setIfGenerationMatch

getIfGenerationNotMatch

setIfGenerationNotMatch

getIfMetagenerationMatch

setIfMetagenerationMatch

getIfMetagenerationNotMatch

setIfMetagenerationNotMatch

getProjection

setProjection

getProvisionalUserProject

setProvisionalUserProject

getUserProject

setUserProject

set