Class Bucket.IpFilter.Builder (2.53.0)

public static final class Bucket.IpFilter.Builder extends GeneratedMessageV3.Builder<Bucket.IpFilter.Builder> 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 Methods

getDescriptor()

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

Methods

addAllVpcNetworkSources(Iterable<? extends Bucket.IpFilter.VpcNetworkSource> values)

public Bucket.IpFilter.Builder addAllVpcNetworkSources(Iterable<? extends Bucket.IpFilter.VpcNetworkSource> values)

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
values Iterable<? extends com.google.storage.v2.Bucket.IpFilter.VpcNetworkSource>
Returns
Type Description
Bucket.IpFilter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Bucket.IpFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

addVpcNetworkSources(Bucket.IpFilter.VpcNetworkSource value)

public Bucket.IpFilter.Builder addVpcNetworkSources(Bucket.IpFilter.VpcNetworkSource value)

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

addVpcNetworkSources(Bucket.IpFilter.VpcNetworkSource.Builder builderForValue)

public Bucket.IpFilter.Builder addVpcNetworkSources(Bucket.IpFilter.VpcNetworkSource.Builder builderForValue)

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

addVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource value)

public Bucket.IpFilter.Builder addVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource value)

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

Parameters
Name Description
index int
value Bucket.IpFilter.VpcNetworkSource
Returns
Type Description
Bucket.IpFilter.Builder

addVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource.Builder builderForValue)

public Bucket.IpFilter.Builder addVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Bucket.IpFilter.VpcNetworkSource.Builder
Returns
Type Description
Bucket.IpFilter.Builder

addVpcNetworkSourcesBuilder()

public Bucket.IpFilter.VpcNetworkSource.Builder addVpcNetworkSourcesBuilder()

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
Bucket.IpFilter.VpcNetworkSource.Builder

addVpcNetworkSourcesBuilder(int index)

public Bucket.IpFilter.VpcNetworkSource.Builder addVpcNetworkSourcesBuilder(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.Builder

build()

public Bucket.IpFilter build()
Returns
Type Description
Bucket.IpFilter

buildPartial()

public Bucket.IpFilter buildPartial()
Returns
Type Description
Bucket.IpFilter

clear()

public Bucket.IpFilter.Builder clear()
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

clearAllowCrossOrgVpcs()

public Bucket.IpFilter.Builder clearAllowCrossOrgVpcs()

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
Bucket.IpFilter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Bucket.IpFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

clearMode()

public Bucket.IpFilter.Builder clearMode()

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
Bucket.IpFilter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Bucket.IpFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

clearPublicNetworkSource()

public Bucket.IpFilter.Builder clearPublicNetworkSource()

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.Builder

clearVpcNetworkSources()

public Bucket.IpFilter.Builder clearVpcNetworkSources()

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
Bucket.IpFilter.Builder

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getPublicNetworkSourceBuilder()

public Bucket.IpFilter.PublicNetworkSource.Builder getPublicNetworkSourceBuilder()

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.Builder

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

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

getVpcNetworkSourcesBuilder(int index)

public Bucket.IpFilter.VpcNetworkSource.Builder getVpcNetworkSourcesBuilder(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.Builder

getVpcNetworkSourcesBuilderList()

public List<Bucket.IpFilter.VpcNetworkSource.Builder> getVpcNetworkSourcesBuilderList()

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<Builder>

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Bucket.IpFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.IpFilter.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Bucket.IpFilter.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

mergeFrom(Bucket.IpFilter other)

public Bucket.IpFilter.Builder mergeFrom(Bucket.IpFilter other)
Parameter
Name Description
other Bucket.IpFilter
Returns
Type Description
Bucket.IpFilter.Builder

mergePublicNetworkSource(Bucket.IpFilter.PublicNetworkSource value)

public Bucket.IpFilter.Builder mergePublicNetworkSource(Bucket.IpFilter.PublicNetworkSource value)

Public IPs allowed to operate or access the bucket.

optional .google.storage.v2.Bucket.IpFilter.PublicNetworkSource public_network_source = 2;

Parameter
Name Description
value Bucket.IpFilter.PublicNetworkSource
Returns
Type Description
Bucket.IpFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Bucket.IpFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

removeVpcNetworkSources(int index)

public Bucket.IpFilter.Builder removeVpcNetworkSources(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.Builder

setAllowCrossOrgVpcs(boolean value)

public Bucket.IpFilter.Builder setAllowCrossOrgVpcs(boolean value)

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

Parameter
Name Description
value boolean

The allowCrossOrgVpcs to set.

Returns
Type Description
Bucket.IpFilter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Bucket.IpFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

setMode(String value)

public Bucket.IpFilter.Builder setMode(String value)

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;

Parameter
Name Description
value String

The mode to set.

Returns
Type Description
Bucket.IpFilter.Builder

This builder for chaining.

setModeBytes(ByteString value)

public Bucket.IpFilter.Builder setModeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for mode to set.

Returns
Type Description
Bucket.IpFilter.Builder

This builder for chaining.

setPublicNetworkSource(Bucket.IpFilter.PublicNetworkSource value)

public Bucket.IpFilter.Builder setPublicNetworkSource(Bucket.IpFilter.PublicNetworkSource value)

Public IPs allowed to operate or access the bucket.

optional .google.storage.v2.Bucket.IpFilter.PublicNetworkSource public_network_source = 2;

Parameter
Name Description
value Bucket.IpFilter.PublicNetworkSource
Returns
Type Description
Bucket.IpFilter.Builder

setPublicNetworkSource(Bucket.IpFilter.PublicNetworkSource.Builder builderForValue)

public Bucket.IpFilter.Builder setPublicNetworkSource(Bucket.IpFilter.PublicNetworkSource.Builder builderForValue)

Public IPs allowed to operate or access the bucket.

optional .google.storage.v2.Bucket.IpFilter.PublicNetworkSource public_network_source = 2;

Parameter
Name Description
builderForValue Bucket.IpFilter.PublicNetworkSource.Builder
Returns
Type Description
Bucket.IpFilter.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Bucket.IpFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Bucket.IpFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Bucket.IpFilter.Builder
Overrides

setVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource value)

public Bucket.IpFilter.Builder setVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource value)

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

Parameters
Name Description
index int
value Bucket.IpFilter.VpcNetworkSource
Returns
Type Description
Bucket.IpFilter.Builder

setVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource.Builder builderForValue)

public Bucket.IpFilter.Builder setVpcNetworkSources(int index, Bucket.IpFilter.VpcNetworkSource.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Bucket.IpFilter.VpcNetworkSource.Builder
Returns
Type Description
Bucket.IpFilter.Builder