Send feedback
Class Bucket.IpFilter (2.53.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public static final class Bucket . IpFilter extends GeneratedMessageV3 implements Bucket . IpFilterOrBuilder
The bucket IP
filtering
configuration. Specifies the network sources that can access the bucket, as
well as its underlying objects.
Protobuf type google.storage.v2.Bucket.IpFilter
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALLOW_CROSS_ORG_VPCS_FIELD_NUMBER
public static final int ALLOW_CROSS_ORG_VPCS_FIELD_NUMBER
Field Value
Type
Description
int
MODE_FIELD_NUMBER
public static final int MODE_FIELD_NUMBER
Field Value
Type
Description
int
PUBLIC_NETWORK_SOURCE_FIELD_NUMBER
public static final int PUBLIC_NETWORK_SOURCE_FIELD_NUMBER
Field Value
Type
Description
int
VPC_NETWORK_SOURCES_FIELD_NUMBER
public static final int VPC_NETWORK_SOURCES_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static Bucket . IpFilter getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Bucket . IpFilter . Builder newBuilder ()
newBuilder(Bucket.IpFilter prototype)
public static Bucket . IpFilter . Builder newBuilder ( Bucket . IpFilter prototype )
public static Bucket . IpFilter parseDelimitedFrom ( InputStream input )
public static Bucket . IpFilter parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Bucket . IpFilter parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Bucket . IpFilter parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Bucket . IpFilter parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Bucket . IpFilter parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Bucket . IpFilter parseFrom ( CodedInputStream input )
public static Bucket . IpFilter parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Bucket . IpFilter parseFrom ( InputStream input )
public static Bucket . IpFilter parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Bucket . IpFilter parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Bucket . IpFilter parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Bucket . IpFilter > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getAllowCrossOrgVpcs()
public 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.
bool allow_cross_org_vpcs = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
boolean
The allowCrossOrgVpcs.
getDefaultInstanceForType()
public Bucket . IpFilter getDefaultInstanceForType ()
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.".
optional string mode = 1;
Returns
Type
Description
String
The mode.
getModeBytes()
public ByteString getModeBytes ()
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.".
optional string mode = 1;
Returns
Type
Description
ByteString
The bytes for mode.
getParserForType()
public Parser<Bucket . IpFilter > getParserForType ()
Overrides
getPublicNetworkSource()
public Bucket . IpFilter . PublicNetworkSource getPublicNetworkSource ()
Public IPs allowed to operate or access the bucket.
optional .google.storage.v2.Bucket.IpFilter.PublicNetworkSource public_network_source = 2;
getPublicNetworkSourceOrBuilder()
public Bucket . IpFilter . PublicNetworkSourceOrBuilder getPublicNetworkSourceOrBuilder ()
Public IPs allowed to operate or access the bucket.
optional .google.storage.v2.Bucket.IpFilter.PublicNetworkSource public_network_source = 2;
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
getVpcNetworkSources(int index)
public Bucket . IpFilter . VpcNetworkSource getVpcNetworkSources ( int index )
Optional. The list of network sources that are allowed to access
operations on the bucket or the underlying objects.
repeated .google.storage.v2.Bucket.IpFilter.VpcNetworkSource vpc_network_sources = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name
Description
index
int
getVpcNetworkSourcesCount()
public int getVpcNetworkSourcesCount ()
Optional. The list of network sources that are allowed to access
operations on the bucket or the underlying objects.
repeated .google.storage.v2.Bucket.IpFilter.VpcNetworkSource vpc_network_sources = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
int
getVpcNetworkSourcesList()
public List<Bucket . IpFilter . VpcNetworkSource > getVpcNetworkSourcesList ()
Optional. The list of network sources that are allowed to access
operations on the bucket or the underlying objects.
repeated .google.storage.v2.Bucket.IpFilter.VpcNetworkSource vpc_network_sources = 3 [(.google.api.field_behavior) = OPTIONAL];
getVpcNetworkSourcesOrBuilder(int index)
public Bucket . IpFilter . VpcNetworkSourceOrBuilder getVpcNetworkSourcesOrBuilder ( int index )
Optional. The list of network sources that are allowed to access
operations on the bucket or the underlying objects.
repeated .google.storage.v2.Bucket.IpFilter.VpcNetworkSource vpc_network_sources = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name
Description
index
int
getVpcNetworkSourcesOrBuilderList()
public List <? extends Bucket . IpFilter . VpcNetworkSourceOrBuilder > getVpcNetworkSourcesOrBuilderList ()
Optional. The list of network sources that are allowed to access
operations on the bucket or the underlying objects.
repeated .google.storage.v2.Bucket.IpFilter.VpcNetworkSource vpc_network_sources = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
List <? extends com.google.storage.v2.Bucket.IpFilter.VpcNetworkSourceOrBuilder >
hasMode()
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.".
optional string mode = 1;
Returns
Type
Description
boolean
Whether the mode field is set.
hasPublicNetworkSource()
public boolean hasPublicNetworkSource ()
Public IPs allowed to operate or access the bucket.
optional .google.storage.v2.Bucket.IpFilter.PublicNetworkSource public_network_source = 2;
Returns
Type
Description
boolean
Whether the publicNetworkSource field is set.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Bucket . IpFilter . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Bucket . IpFilter . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public Bucket . IpFilter . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[],[]]