ObjectsGetOptions

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

Additional options for Storage#objectsGet.

interface ObjectsGetOptions {

generation?: bigint;

ifGenerationMatch?: bigint;

ifGenerationNotMatch?: bigint;

ifMetagenerationMatch?: bigint;

ifMetagenerationNotMatch?: bigint;

projection?: "full" | "noAcl";

restoreToken?: string;

softDeleted?: boolean;

userProject?: string;

}

§Properties

generation?: bigint

[src]

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

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 object's current metageneration matches the given value.

ifMetagenerationNotMatch?: bigint

[src]

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

projection?: "full" | "noAcl"

[src]

Set of properties to return. Defaults to noAcl.

restoreToken?: string

[src]

Restore token used to differentiate soft-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets and if softDeleted is set to true. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.

softDeleted?: boolean

[src]

If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.

userProject?: string

[src]

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