ObjectsInsertOptions

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

Additional options for Storage#objectsInsert.

interface ObjectsInsertOptions {

contentEncoding?: string;

ifGenerationMatch?: bigint;

ifGenerationNotMatch?: bigint;

ifMetagenerationMatch?: bigint;

ifMetagenerationNotMatch?: bigint;

kmsKeyName?: string;

name?: string;

predefinedAcl?:

| "authenticatedRead"

| "bucketOwnerFullControl"

| "bucketOwnerRead"

| "private"

| "projectPrivate"

| "publicRead";

projection?: "full" | "noAcl";

userProject?: string;

}

§Properties

contentEncoding?: string

[src]

If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.

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.

kmsKeyName?: 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.

name?: string

[src]

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

[src]

Apply a predefined set of access controls to this object.

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.

userProject?: string

[src]

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