ObjectsRewriteOptions

import type { ObjectsRewriteOptions } from "https://googleapis.deno.dev/v1/storage:v1.ts";

Additional options for Storage#objectsRewrite.

interface ObjectsRewriteOptions {

destinationKmsKeyName?: string;

destinationPredefinedAcl?:

| "authenticatedRead"

| "bucketOwnerFullControl"

| "bucketOwnerRead"

| "private"

| "projectPrivate"

| "publicRead";

ifGenerationMatch?: bigint;

ifGenerationNotMatch?: bigint;

ifMetagenerationMatch?: bigint;

ifMetagenerationNotMatch?: bigint;

ifSourceGenerationMatch?: bigint;

ifSourceGenerationNotMatch?: bigint;

ifSourceMetagenerationMatch?: bigint;

ifSourceMetagenerationNotMatch?: bigint;

maxBytesRewrittenPerCall?: bigint;

projection?: "full" | "noAcl";

rewriteToken?: string;

sourceGeneration?: bigint;

userProject?: string;

}

§Properties

destinationKmsKeyName?: string

[src]

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.

[src]

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

ifGenerationMatch?: bigint

[src]

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.

ifGenerationNotMatch?: bigint

[src]

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.

ifMetagenerationMatch?: bigint

[src]

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

ifMetagenerationNotMatch?: bigint

[src]

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

ifSourceGenerationMatch?: bigint

[src]

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

ifSourceGenerationNotMatch?: bigint

[src]

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

ifSourceMetagenerationMatch?: bigint

[src]

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

ifSourceMetagenerationNotMatch?: bigint

[src]

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

maxBytesRewrittenPerCall?: bigint

[src]

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.

projection?: "full" | "noAcl"

[src]

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

rewriteToken?: string

[src]

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.

sourceGeneration?: bigint

[src]

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

userProject?: string

[src]

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