Class Bucket.IpFilter (2.53.0)

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

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()
Returns
Type Description
Bucket.IpFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Bucket.IpFilter.Builder newBuilder()
Returns
Type Description
Bucket.IpFilter.Builder

newBuilder(Bucket.IpFilter prototype)

public static Bucket.IpFilter.Builder newBuilder(Bucket.IpFilter prototype)
Parameter
Name Description
prototype Bucket.IpFilter
Returns
Type Description
Bucket.IpFilter.Builder

parseDelimitedFrom(InputStream input)

public static Bucket.IpFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket.IpFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Bucket.IpFilter parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Bucket.IpFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Bucket.IpFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Bucket.IpFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Bucket.IpFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket.IpFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Bucket.IpFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket.IpFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Bucket.IpFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Bucket.IpFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.IpFilter
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Bucket.IpFilter> parser()
Returns
Type Description
Parser<IpFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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()
Returns
Type Description
Bucket.IpFilter

getMode()

public 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.".

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()
Returns
Type Description
Parser<IpFilter>
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;

Returns
Type Description
Bucket.IpFilter.PublicNetworkSource

The publicNetworkSource.

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;

Returns
Type Description
Bucket.IpFilter.PublicNetworkSourceOrBuilder

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
Returns
Type Description
Bucket.IpFilter.VpcNetworkSource

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];

Returns
Type Description
List<VpcNetworkSource>

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
Returns
Type Description
Bucket.IpFilter.VpcNetworkSourceOrBuilder

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()

public boolean 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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Bucket.IpFilter.Builder newBuilderForType()
Returns
Type Description
Bucket.IpFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Bucket.IpFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Bucket.IpFilter.Builder toBuilder()
Returns
Type Description
Bucket.IpFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException