Cloud Storage API v1beta2 (revision 2)

com.google.api.services.storage
Class Storage.Objects.Insert

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.Insert
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>

Constructor Summary

protected	Storage.Objects.Insert(String bucket, StorageObject content) Stores new data blobs and associated metadata.
protected	Storage.Objects.Insert(String bucket, StorageObject content, AbstractInputStreamContent mediaContent) Stores new data blobs and associated metadata.

Method Summary

HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
String	getBucket() Name of the bucket in which to store the new object.
BigInteger	getIfGenerationMatch() Makes the operation conditional on whether the object's current generation matches the given value.
BigInteger	getIfGenerationNotMatch() Makes the operation conditional on whether the object's current generation does not match the given value.
BigInteger	getIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
BigInteger	getIfMetagenerationNotMatch() Makes the operation conditional on whether the object's current metageneration does not match the given value.
String	getName() Name of the object.
String	getProjection() Set of properties to return.
Storage.Objects.Insert	set(String parameterName, Object value)
Storage.Objects.Insert	setAlt(String alt) Data format for the response.
Storage.Objects.Insert	setBucket(String bucket) Name of the bucket in which to store the new object.
Storage.Objects.Insert	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Insert	setIfGenerationMatch(BigInteger ifGenerationMatch) Makes the operation conditional on whether the object's current generation matches the given value.
Storage.Objects.Insert	setIfGenerationNotMatch(BigInteger ifGenerationNotMatch) Makes the operation conditional on whether the object's current generation does not match the given value.
Storage.Objects.Insert	setIfMetagenerationMatch(BigInteger ifMetagenerationMatch) Makes the operation conditional on whether the object's current metageneration matches the given value.
Storage.Objects.Insert	setIfMetagenerationNotMatch(BigInteger ifMetagenerationNotMatch) Makes the operation conditional on whether the object's current metageneration does not match the given value.
Storage.Objects.Insert	setKey(String key) API key.
Storage.Objects.Insert	setName(String name) Name of the object.
Storage.Objects.Insert	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.Insert	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.Insert	setProjection(String projection) Set of properties to return.
Storage.Objects.Insert	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Storage.Objects.Insert	setUserIp(String userIp) IP address of the site where the request originates.

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, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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

Storage.Objects.Insert

protected Storage.Objects.Insert(String bucket,
                                 StorageObject content)

Stores new data blobs and associated metadata. Create a request for the method "objects.insert". 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 to store the new object. Overrides the provided object metadata's bucket value, if any.

content - the StorageObject

Since:

1.13

Storage.Objects.Insert

protected Storage.Objects.Insert(String bucket,
                                 StorageObject content,
                                 AbstractInputStreamContent mediaContent)

Stores new data blobs and associated metadata. Create a request for the method "objects.insert". 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.

This constructor should be used for uploading media content.

Parameters:

bucket - Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.

content - the StorageObject media metadata or null if none

mediaContent - The media HTTP content or null if none.

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

setAlt

public Storage.Objects.Insert setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<StorageObject>

setFields

public Storage.Objects.Insert 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.Insert 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.Insert 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.Insert 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.Insert setQuotaUser(String quotaUser)

Description copied from class: StorageRequest

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.

Overrides:

setQuotaUser in class StorageRequest<StorageObject>

setUserIp

public Storage.Objects.Insert setUserIp(String userIp)

Description copied from class: StorageRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class StorageRequest<StorageObject>

getBucket

public String getBucket()

Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.

setBucket

public Storage.Objects.Insert setBucket(String bucket)

Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.

getProjection

public String getProjection()

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

setProjection

public Storage.Objects.Insert setProjection(String projection)

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

getIfGenerationNotMatch

public BigInteger getIfGenerationNotMatch()

Makes the operation conditional on whether the object's current generation does not match the given value.

setIfGenerationNotMatch

public Storage.Objects.Insert setIfGenerationNotMatch(BigInteger ifGenerationNotMatch)

Makes the operation conditional on whether the object's current generation does not match the given value.

getIfMetagenerationMatch

public BigInteger getIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

setIfMetagenerationMatch

public Storage.Objects.Insert setIfMetagenerationMatch(BigInteger ifMetagenerationMatch)

Makes the operation conditional on whether the object's current metageneration matches the given value.

getIfGenerationMatch

public BigInteger getIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value.

setIfGenerationMatch

public Storage.Objects.Insert setIfGenerationMatch(BigInteger ifGenerationMatch)

Makes the operation conditional on whether the object's current generation matches the given value.

getIfMetagenerationNotMatch

public BigInteger getIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

setIfMetagenerationNotMatch

public Storage.Objects.Insert setIfMetagenerationNotMatch(BigInteger ifMetagenerationNotMatch)

Makes the operation conditional on whether the object's current metageneration does not match the given value.

getName

public String getName()

Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.

setName

public Storage.Objects.Insert setName(String name)

Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.

set

public Storage.Objects.Insert set(String parameterName,
                                  Object value)

Overrides:

set in class StorageRequest<StorageObject>