Storage.Objects.Compose (Cloud Storage JSON API v1-rev20181013-1.27.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

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

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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Compose(String destinationBucket, String destinationObject, ComposeRequest content)` Concatenates a list of existing objects into a new object in the same bucket.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDestinationBucket()` Name of the bucket containing the source objects.
`String`	`getDestinationObject()` Name of the new object.
`String`	`getDestinationPredefinedAcl()` Apply a predefined set of access controls to the destination object.
`Long`	`getIfGenerationMatch()` Makes the operation conditional on whether the object's current generation matches the given value.
`Long`	`getIfMetagenerationMatch()` Makes the operation conditional on whether the object's current metageneration matches 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`	`getUserProject()` The project to be billed for this request.
`Storage.Objects.Compose`	`set(String parameterName, Object value)`
`Storage.Objects.Compose`	`setAlt(String alt)` Data format for the response.
`Storage.Objects.Compose`	`setDestinationBucket(String destinationBucket)` Name of the bucket containing the source objects.
`Storage.Objects.Compose`	`setDestinationObject(String destinationObject)` Name of the new object.
`Storage.Objects.Compose`	`setDestinationPredefinedAcl(String destinationPredefinedAcl)` Apply a predefined set of access controls to the destination object.
`Storage.Objects.Compose`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Objects.Compose`	`setIfGenerationMatch(Long ifGenerationMatch)` Makes the operation conditional on whether the object's current generation matches the given value.
`Storage.Objects.Compose`	`setIfMetagenerationMatch(Long ifMetagenerationMatch)` Makes the operation conditional on whether the object's current metageneration matches the given value.
`Storage.Objects.Compose`	`setKey(String key)` API key.
`Storage.Objects.Compose`	`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.Compose`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Storage.Objects.Compose`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storage.Objects.Compose`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Storage.Objects.Compose`	`setUserIp(String userIp)` Deprecated.
`Storage.Objects.Compose`	`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
  - Compose
```
protected Compose(String destinationBucket,
                  String destinationObject,
                  ComposeRequest content)
```
    Concatenates a list of existing objects into a new object in the same bucket. Create a request for the method "objects.compose". 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:
    
    destinationBucket - Name of the bucket containing the source objects. The destination object is stored in this bucket.
    
    destinationObject - Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
    
    content - the ComposeRequest
    
    Since:
    
    1.13
- Method Detail
  - setAlt
```
public Storage.Objects.Compose setAlt(String alt)
```
    Description copied from class: StorageRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class StorageRequest<StorageObject>
  - setFields
```
public Storage.Objects.Compose 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.Compose 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.Compose 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.Compose 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.Compose 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.Compose setUserIp(String userIp)
```
    Description copied from class: StorageRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class StorageRequest<StorageObject>
  - getDestinationBucket
```
public String getDestinationBucket()
```
    Name of the bucket containing the source objects. The destination object is stored in this bucket.
  - setDestinationBucket
```
public Storage.Objects.Compose setDestinationBucket(String destinationBucket)
```
    Name of the bucket containing the source objects. The destination object is stored in this bucket.
  - getDestinationObject
```
public String getDestinationObject()
```
    Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  - setDestinationObject
```
public Storage.Objects.Compose setDestinationObject(String destinationObject)
```
    Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  - getDestinationPredefinedAcl
```
public String getDestinationPredefinedAcl()
```
    Apply a predefined set of access controls to the destination object.
  - setDestinationPredefinedAcl
```
public Storage.Objects.Compose setDestinationPredefinedAcl(String destinationPredefinedAcl)
```
    Apply a predefined set of access controls to the destination object.
  - 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.Compose 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.
  - getIfMetagenerationMatch
```
public Long getIfMetagenerationMatch()
```
    Makes the operation conditional on whether the object's current metageneration matches the given value.
  - setIfMetagenerationMatch
```
public Storage.Objects.Compose setIfMetagenerationMatch(Long ifMetagenerationMatch)
```
    Makes the operation conditional on whether the object's current metageneration matches 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.Compose 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.
  - getUserProject
```
public String getUserProject()
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - setUserProject
```
public Storage.Objects.Compose setUserProject(String userProject)
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - set
```
public Storage.Objects.Compose set(String parameterName,
                                   Object value)
```
    Overrides:
    
    set in class StorageRequest<StorageObject>

Class Storage.Objects.Compose

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

Compose

Method Detail

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getDestinationBucket

setDestinationBucket

getDestinationObject

setDestinationObject

getDestinationPredefinedAcl

setDestinationPredefinedAcl

getIfGenerationMatch

setIfGenerationMatch

getIfMetagenerationMatch

setIfMetagenerationMatch

getKmsKeyName

setKmsKeyName

getUserProject

setUserProject

set