Class Storage.BucketTargetOption (2.43.1)

public static class Storage.BucketTargetOption extends Option<UnifiedOpts.BucketTargetOpt>

Class for specifying bucket target options.

Inheritance

java.lang.Object > com.google.cloud.storage.UnifiedOpts.OptionShim > Option > Storage.BucketTargetOption

Inherited Members

com.google.cloud.storage.UnifiedOpts.OptionShim.equals(java.lang.Object)

com.google.cloud.storage.UnifiedOpts.OptionShim.hashCode()

com.google.cloud.storage.UnifiedOpts.OptionShim.toString()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

dedupe(Storage.BucketTargetOption[] os)

public static Storage.BucketTargetOption[] dedupe(Storage.BucketTargetOption[] os)

Deduplicate any options which are the same parameter. The value which comes last in os will be the value included in the return.

Parameter
Name	Description
`os`	`BucketTargetOption[]`

Returns
Type	Description
`BucketTargetOption[]`

dedupe(Storage.BucketTargetOption[] array, Storage.BucketTargetOption[] os)

public static Storage.BucketTargetOption[] dedupe(Storage.BucketTargetOption[] array, Storage.BucketTargetOption[] os)

Deduplicate any options which are the same parameter.

The value which comes last in collection and os will be the value included in the return. All options from os will override their counterparts in collection.

Parameters
Name	Description
`array`	`BucketTargetOption[]`
`os`	`BucketTargetOption[]`

Returns
Type	Description
`BucketTargetOption[]`

dedupe(Collection<Storage.BucketTargetOption> collection, Storage.BucketTargetOption[] os)

public static Storage.BucketTargetOption[] dedupe(Collection<Storage.BucketTargetOption> collection, Storage.BucketTargetOption[] os)

Deduplicate any options which are the same parameter.

The value which comes last in collection and os will be the value included in the return. All options from os will override their counterparts in collection.

Parameters
Name	Description
`collection`	`Collection<BucketTargetOption>`
`os`	`BucketTargetOption[]`

Returns
Type	Description
`BucketTargetOption[]`

enableObjectRetention(boolean enable)

public static Storage.BucketTargetOption enableObjectRetention(boolean enable)

Returns an option for enabling Object Retention on this bucket. Enabling this will create an ObjectRetention object in the created bucket (You must use this option, creating your own ObjectRetention object in the request won't work).

Parameter
Name	Description
`enable`	`boolean`

Returns
Type	Description
`Storage.BucketTargetOption`

metagenerationMatch()

public static Storage.BucketTargetOption metagenerationMatch()

Returns an option for bucket's metageneration match. If this option is used the request will fail if metageneration does not match.

Returns
Type	Description
`Storage.BucketTargetOption`

metagenerationNotMatch()

public static Storage.BucketTargetOption metagenerationNotMatch()

Returns an option for bucket's metageneration mismatch. If this option is used the request will fail if metageneration matches.

Returns
Type	Description
`Storage.BucketTargetOption`

predefinedAcl(@NonNull Storage.PredefinedAcl acl)

public static Storage.BucketTargetOption predefinedAcl(@NonNull Storage.PredefinedAcl acl)

Returns an option for specifying bucket's predefined ACL configuration.

Parameter
Name	Description
`acl`	`@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.Storage.PredefinedAcl`

Returns
Type	Description
`Storage.BucketTargetOption`

predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)

public static Storage.BucketTargetOption predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)

Returns an option for specifying bucket's default ACL configuration for blobs.

Parameter
Name	Description
`acl`	`@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.Storage.PredefinedAcl`

Returns
Type	Description
`Storage.BucketTargetOption`

projection(@NonNull String projection)

public static Storage.BucketTargetOption projection(@NonNull String projection)

Returns an option to define the projection in the API request. In some cases this option may be needed to be set to noAcl to omit ACL data from the response. The default value is full See Also: Buckets: patch

Parameter
Name	Description
`projection`	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String`

Returns
Type	Description
`Storage.BucketTargetOption`

userProject(@NonNull String userProject)

public static Storage.BucketTargetOption userProject(@NonNull String userProject)

Returns an option to define the billing user project. This option is required by buckets with requester_pays flag enabled to assign operation costs.

Parameter
Name	Description
`userProject`	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String`

Returns
Type	Description
`Storage.BucketTargetOption`