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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Insert(String bucket, StorageObject content) Stores a new object and metadata.
protected	Insert(String bucket, StorageObject content, AbstractInputStreamContent mediaContent) Stores a new object and metadata.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of the bucket in which to store the new object.
String	getContentEncoding() If set, sets the contentEncoding property of the final object to this value.
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	getKmsKeyName() Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my- kr/cryptoKeys/my-key, that will be used to encrypt the object.
String	getName() Name of the object.
String	getPredefinedAcl() Apply a predefined set of access controls to this 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.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	setContentEncoding(String contentEncoding) If set, sets the contentEncoding property of the final object to this value.
Storage.Objects.Insert	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Insert	setIfGenerationMatch(Long ifGenerationMatch) Makes the operation conditional on whether the object's current generation matches the given value.
Storage.Objects.Insert	setIfGenerationNotMatch(Long ifGenerationNotMatch) Makes the operation conditional on whether the object's current generation does not match the given value.
Storage.Objects.Insert	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the operation conditional on whether the object's current metageneration matches the given value.
Storage.Objects.Insert	setIfMetagenerationNotMatch(Long 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	setKmsKeyName(String kmsKeyName) Resource name of the Cloud KMS key, of the form projects/my- project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object.
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	setPredefinedAcl(String predefinedAcl) Apply a predefined set of access controls to this object.
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	setProvisionalUserProject(String provisionalUserProject) The project to be billed for this request if the target bucket is requester-pays bucket.
Storage.Objects.Insert	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Objects.Insert	setUserIp(String userIp) Deprecated.
Storage.Objects.Insert	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, 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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Insert

protected Insert(String bucket,
                 StorageObject content)

Stores a new object and 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

Insert

protected Insert(String bucket,
                 StorageObject content,
                 AbstractInputStreamContent mediaContent)

Stores a new object and 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

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

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

getContentEncoding

public String getContentEncoding()

If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.

setContentEncoding

public Storage.Objects.Insert setContentEncoding(String contentEncoding)

If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.

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.Insert 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.Insert 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.Insert 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.Insert setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

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

getKmsKeyName

public String getKmsKeyName()

Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my- kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.

setKmsKeyName

public Storage.Objects.Insert setKmsKeyName(String kmsKeyName)

Resource name of the Cloud KMS key, of the form projects/my- project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.

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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

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. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

getPredefinedAcl

public String getPredefinedAcl()

Apply a predefined set of access controls to this object.

setPredefinedAcl

public Storage.Objects.Insert setPredefinedAcl(String predefinedAcl)

Apply a predefined set of access controls to this object.

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.

getProvisionalUserProject

public String getProvisionalUserProject()

The project to be billed for this request if the target bucket is requester-pays bucket.

setProvisionalUserProject

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

The project to be billed for this request. Required for Requester Pays buckets.

set

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

Overrides:

set in class StorageRequest<StorageObject>