Class ObjectsResource.RewriteRequest

Rewrites a source object to a destination object. Optionally overrides metadata.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<RewriteResponse>
StorageBaseServiceRequest<RewriteResponse>
ObjectsResource.RewriteRequest
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 RewriteRequest : StorageBaseServiceRequest<RewriteResponse>, IClientServiceRequest<RewriteResponse>, IClientServiceRequest

Constructors

RewriteRequest(IClientService, Object, String, String, String, String)

Constructs a new Rewrite request.

Declaration
public RewriteRequest(IClientService service, Object body, string sourceBucket, string sourceObject, string destinationBucket, string destinationObject)
Parameters
Type Name Description
IClientService service
Object body
System.String sourceBucket
System.String sourceObject
System.String destinationBucket
System.String destinationObject

Properties

DestinationBucket

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

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

DestinationKmsKeyName

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("destinationKmsKeyName", RequestParameterType.Query)]
public virtual string DestinationKmsKeyName { get; set; }
Property Value
Type Description
System.String

DestinationObject

Name of the new 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.

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.RewriteRequest.DestinationPredefinedAclEnum? DestinationPredefinedAcl { get; set; }
Property Value
Type Description
System.Nullable<ObjectsResource.RewriteRequest.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.RewriteResponse>.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>

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.

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

IfMetagenerationMatch

Makes the operation conditional on whether the destination 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>

IfMetagenerationNotMatch

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

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

IfSourceGenerationMatch

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

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

IfSourceGenerationNotMatch

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

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

IfSourceMetagenerationMatch

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

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

IfSourceMetagenerationNotMatch

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

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

MaxBytesRewrittenPerCall

The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.

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

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.RewriteResponse>.MethodName

Projection

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

Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual ObjectsResource.RewriteRequest.ProjectionEnum? Projection { get; set; }
Property Value
Type Description
System.Nullable<ObjectsResource.RewriteRequest.ProjectionEnum>

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.RewriteResponse>.RestPath

RewriteToken

Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.

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

SourceBucket

Name of the bucket in which to find the source object.

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

SourceGeneration

If present, selects a specific revision of the source object (as opposed to the latest version, the default).

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

SourceObject

Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

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

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.RewriteResponse>.GetBody()

InitParameters()

Initializes Rewrite parameter list.

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

Implements