Package com.google.cloud.storage

Class Storage.BucketTargetOption

java.lang.Object

com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.BucketTargetOpt>

com.google.cloud.storage.Storage.BucketTargetOption

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage

public static class Storage.BucketTargetOption
extends Option<com.google.cloud.storage.UnifiedOpts.BucketTargetOpt>

Class for specifying bucket target options.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static Storage.BucketTargetOption[]	dedupe(Storage.BucketTargetOption... os)	Deduplicate any options which are the same parameter.
static Storage.BucketTargetOption[]	dedupe(Storage.BucketTargetOption[] array, Storage.BucketTargetOption... os)	Deduplicate any options which are the same parameter.
static Storage.BucketTargetOption[]	dedupe(Collection<Storage.BucketTargetOption> collection, Storage.BucketTargetOption... os)	Deduplicate any options which are the same parameter.
static Storage.BucketTargetOption	enableObjectRetention(boolean enable)	Returns an option for enabling Object Retention on this bucket.
boolean	equals(Object o)	Deprecated.
int	hashCode()	Deprecated.
static Storage.BucketTargetOption	metagenerationMatch()	Returns an option for bucket's metageneration match.
static Storage.BucketTargetOption	metagenerationNotMatch()	Returns an option for bucket's metageneration mismatch.
static Storage.BucketTargetOption	predefinedAcl(@NonNull Storage.PredefinedAcl acl)	Returns an option for specifying bucket's predefined ACL configuration.
static Storage.BucketTargetOption	predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)	Returns an option for specifying bucket's default ACL configuration for blobs.
static Storage.BucketTargetOption	projection(@NonNull String projection)	Returns an option to define the projection in the API request.
String	toString()	Deprecated.
static Storage.BucketTargetOption	userProject(@NonNull String userProject)	Returns an option to define the billing user project.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

predefinedAcl

@TransportCompatibility({HTTP,GRPC})
public static Storage.BucketTargetOption predefinedAcl(@NonNull Storage.PredefinedAcl acl)

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

predefinedDefaultObjectAcl

@TransportCompatibility({HTTP,GRPC})
public static Storage.BucketTargetOption predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)

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

enableObjectRetention

@TransportCompatibility(HTTP)
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).

metagenerationMatch

@TransportCompatibility({HTTP,GRPC})
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.

metagenerationNotMatch

@TransportCompatibility({HTTP,GRPC})
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.

userProject

@TransportCompatibility({HTTP,GRPC})
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.

projection

@TransportCompatibility(HTTP)
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

dedupe

@BetaApi
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.

dedupe

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.

dedupe

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.

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object