Class ObjectsResource.ComposeRequest

Concatenates a list of existing objects into a new object in the same bucket.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Object>
StorageBaseServiceRequest<Object>
ObjectsResource.ComposeRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Storage.v1
Assembly: Google.Apis.Storage.v1.dll
Syntax
public class ComposeRequest : StorageBaseServiceRequest<Object>, IClientServiceRequest<Object>, IClientServiceRequest

Constructors

ComposeRequest(IClientService, ComposeRequest, String, String)

Constructs a new Compose request.

Declaration
public ComposeRequest(IClientService service, ComposeRequest body, string destinationBucket, string destinationObject)
Parameters
Type Name Description
IClientService service
ComposeRequest body
System.String destinationBucket
System.String destinationObject

Properties

DestinationBucket

Name of the bucket containing the source objects. The destination object is stored in this bucket.

Declaration
[RequestParameter("destinationBucket", RequestParameterType.Path)]
public virtual string DestinationBucket { get; }
Property Value
Type Description
System.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.

Declaration
[RequestParameter("destinationObject", RequestParameterType.Path)]
public virtual string DestinationObject { get; }
Property Value
Type Description
System.String

DestinationPredefinedAcl

Apply a predefined set of access controls to the destination object.

Declaration
[RequestParameter("destinationPredefinedAcl", RequestParameterType.Query)]
public virtual ObjectsResource.ComposeRequest.DestinationPredefinedAclEnum? DestinationPredefinedAcl { get; set; }
Property Value
Type Description
System.Nullable<ObjectsResource.ComposeRequest.DestinationPredefinedAclEnum>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1.Data.Object>.HttpMethod

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.

Declaration
[RequestParameter("ifGenerationMatch", RequestParameterType.Query)]
public virtual long? IfGenerationMatch { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

IfMetagenerationMatch

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

Declaration
[RequestParameter("ifMetagenerationMatch", RequestParameterType.Query)]
public virtual long? IfMetagenerationMatch { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

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.

Declaration
[RequestParameter("kmsKeyName", RequestParameterType.Query)]
public virtual string KmsKeyName { get; set; }
Property Value
Type Description
System.String

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1.Data.Object>.MethodName

ProvisionalUserProject

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

Declaration
[RequestParameter("provisionalUserProject", RequestParameterType.Query)]
public virtual string ProvisionalUserProject { get; set; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1.Data.Object>.RestPath

UserProject

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

Declaration
[RequestParameter("userProject", RequestParameterType.Query)]
public virtual string UserProject { get; set; }
Property Value
Type Description
System.String

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1.Data.Object>.GetBody()

InitParameters()

Initializes Compose parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Storage.v1.StorageBaseServiceRequest<Google.Apis.Storage.v1.Data.Object>.InitParameters()

Implements