Package com.google.cloud.storage

Class BucketInfo.IpFilter

java.lang.Object

com.google.cloud.storage.BucketInfo.IpFilter

All Implemented Interfaces:

Serializable

Enclosing class:

BucketInfo

@Immutable
public static final class BucketInfo.IpFilter
extends Object
implements Serializable

A buckets IP filtering configuration. Specifies the network sources that can access the bucket, as well as its underlying objects.

Since:

2.54.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BucketInfo.IpFilter.Builder
static final class	BucketInfo.IpFilter.PublicNetworkSource	The public network IP address ranges that can access the bucket and its data.
static final class	BucketInfo.IpFilter.VpcNetworkSource	The list of VPC networks that can access the bucket.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable Boolean	getAllowAllServiceAgentAccess()	Whether or not to allow all P4SA access to the bucket.
@Nullable Boolean	getAllowCrossOrgVpcs()	Optional.
@Nullable String	getMode()	The state of the IP filter configuration.
@Nullable BucketInfo.IpFilter.PublicNetworkSource	getPublicNetworkSource()	Optional.
@Nullable List<BucketInfo.IpFilter.VpcNetworkSource>	getVpcNetworkSources()	Optional.
int	hashCode()
static BucketInfo.IpFilter.Builder	newBuilder()
BucketInfo.IpFilter.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getMode

public @Nullable String getMode()

The state of the IP filter configuration. Valid values are `Enabled` and `Disabled`. When set to `Enabled`, IP filtering rules are applied to a bucket and all incoming requests to the bucket are evaluated against these rules. When set to `Disabled`, IP filtering rules are not applied to a bucket.

Since:

2.54.0

See Also:

• BucketInfo.IpFilter.Builder.setMode(java.lang.String)

getPublicNetworkSource

public @Nullable BucketInfo.IpFilter.PublicNetworkSource getPublicNetworkSource()

Optional. Public IPs allowed to operate or access the bucket.

Since:

2.54.0

See Also:

• BucketInfo.IpFilter.Builder.setPublicNetworkSource(PublicNetworkSource)

getVpcNetworkSources

public @Nullable List<BucketInfo.IpFilter.VpcNetworkSource> getVpcNetworkSources()

Optional. The list of network sources that are allowed to access operations on the bucket or the underlying objects.

Since:

2.54.0

See Also:

• BucketInfo.IpFilter.Builder.setVpcNetworkSources(List)

getAllowCrossOrgVpcs

public @Nullable Boolean getAllowCrossOrgVpcs()

Optional. Whether or not to allow VPCs from orgs different than the bucket's parent org to access the bucket. When set to true, validations on the existence of the VPCs won't be performed. If set to false, each VPC network source will be checked to belong to the same org as the bucket as well as validated for existence.

Since:

2.54.0

See Also:

• BucketInfo.IpFilter.Builder.setAllowCrossOrgVpcs(Boolean)

getAllowAllServiceAgentAccess

public @Nullable Boolean getAllowAllServiceAgentAccess()

Whether or not to allow all P4SA access to the bucket. When set to true, IP filter config validation will not apply.

Since:

2.54.0

See Also:

• BucketInfo.IpFilter.Builder.setAllowAllServiceAgentAccess(Boolean)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public BucketInfo.IpFilter.Builder toBuilder()

Since:

2.54.0

newBuilder

public static BucketInfo.IpFilter.Builder newBuilder()

Since:

2.54.0