Class Storage.BucketGetOption (2.36.1)

public static class Storage.BucketGetOption extends Option<UnifiedOpts.BucketSourceOpt>

Class for specifying bucket get options.

Inheritance

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

Static Methods

dedupe(Storage.BucketGetOption[] os)

public static Storage.BucketGetOption[] dedupe(Storage.BucketGetOption[] 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
NameDescription
osBucketGetOption[]
Returns
TypeDescription
BucketGetOption[]

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

public static Storage.BucketGetOption[] dedupe(Storage.BucketGetOption[] array, Storage.BucketGetOption[] 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
NameDescription
arrayBucketGetOption[]
osBucketGetOption[]
Returns
TypeDescription
BucketGetOption[]

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

public static Storage.BucketGetOption[] dedupe(Collection<Storage.BucketGetOption> collection, Storage.BucketGetOption[] 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
NameDescription
collectionCollection<BucketGetOption>
osBucketGetOption[]
Returns
TypeDescription
BucketGetOption[]

fields(Storage.BucketField[] fields)

public static Storage.BucketGetOption fields(Storage.BucketField[] fields)

Returns an option to specify the bucket's fields to be returned by the RPC call. If this option is not provided all bucket's fields are returned. BucketGetOption.fields) can be used to specify only the fields of interest. Bucket name is always returned, even if not specified.

Parameter
NameDescription
fieldsBucketField[]
Returns
TypeDescription
Storage.BucketGetOption

metagenerationMatch(long metageneration)

public static Storage.BucketGetOption metagenerationMatch(long metageneration)

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

Parameter
NameDescription
metagenerationlong
Returns
TypeDescription
Storage.BucketGetOption

metagenerationNotMatch(long metageneration)

public static Storage.BucketGetOption metagenerationNotMatch(long metageneration)

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

Parameter
NameDescription
metagenerationlong
Returns
TypeDescription
Storage.BucketGetOption

userProject(@NonNull String userProject)

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

Returns an option for bucket's billing user project. This option is only used by the buckets with 'requester_pays' flag.

Parameter
NameDescription
userProject@org.checkerframework.checker.nullness.qual.NonNull java.lang.String
Returns
TypeDescription
Storage.BucketGetOption