Package com.google.storage.v2

Class Bucket.IpFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.Bucket.IpFilter
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Bucket.IpFilterOrBuilder, Serializable
Enclosing class:
Bucket
public static final class Bucket.IpFilter extends com.google.protobuf.GeneratedMessageV3 implements Bucket.IpFilterOrBuilder
 The [bucket IP
 filtering](https://cloud.google.com/storage/docs/ip-filtering-overview)
 configuration. Specifies the network sources that can access the bucket, as
 well as its underlying objects.
Protobuf type google.storage.v2.Bucket.IpFilter
See Also:

  • Field Details

    • MODE_FIELD_NUMBER

      public static final int MODE_FIELD_NUMBER
      See Also:

    • PUBLIC_NETWORK_SOURCE_FIELD_NUMBER

      public static final int PUBLIC_NETWORK_SOURCE_FIELD_NUMBER
      See Also:

    • VPC_NETWORK_SOURCES_FIELD_NUMBER

      public static final int VPC_NETWORK_SOURCES_FIELD_NUMBER
      See Also:

    • ALLOW_CROSS_ORG_VPCS_FIELD_NUMBER

      public static final int ALLOW_CROSS_ORG_VPCS_FIELD_NUMBER
      See Also:

    • ALLOW_ALL_SERVICE_AGENT_ACCESS_FIELD_NUMBER

      public static final int ALLOW_ALL_SERVICE_AGENT_ACCESS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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;
      Specified by:
      hasMode in interface Bucket.IpFilterOrBuilder
      Returns:
      Whether the mode field is set.

    • 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;
      Specified by:
      getMode in interface Bucket.IpFilterOrBuilder
      Returns:
      The mode.

    • getModeBytes

      public com.google.protobuf.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;
      Specified by:
      getModeBytes in interface Bucket.IpFilterOrBuilder
      Returns:
      The bytes for mode.

    • hasPublicNetworkSource

      public boolean hasPublicNetworkSource()
       Public IPs allowed to operate or access the bucket.
      optional .google.storage.v2.Bucket.IpFilter.PublicNetworkSource public_network_source = 2;
      Specified by:
      hasPublicNetworkSource in interface Bucket.IpFilterOrBuilder
      Returns:
      Whether the publicNetworkSource field is set.

    • 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;
      Specified by:
      getPublicNetworkSource in interface Bucket.IpFilterOrBuilder
      Returns:
      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;
      Specified by:
      getPublicNetworkSourceOrBuilder in interface Bucket.IpFilterOrBuilder

    • 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];
      Specified by:
      getVpcNetworkSourcesList in interface Bucket.IpFilterOrBuilder

    • 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];
      Specified by:
      getVpcNetworkSourcesOrBuilderList in interface Bucket.IpFilterOrBuilder

    • 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];
      Specified by:
      getVpcNetworkSourcesCount in interface Bucket.IpFilterOrBuilder

    • getVpcNetworkSources

      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];
      Specified by:
      getVpcNetworkSources in interface Bucket.IpFilterOrBuilder

    • getVpcNetworkSourcesOrBuilder

      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];
      Specified by:
      getVpcNetworkSourcesOrBuilder in interface Bucket.IpFilterOrBuilder

    • 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];
      Specified by:
      getAllowCrossOrgVpcs in interface Bucket.IpFilterOrBuilder
      Returns:
      The allowCrossOrgVpcs.

    • hasAllowAllServiceAgentAccess

      public boolean hasAllowAllServiceAgentAccess()
       Whether or not to allow all P4SA access to the bucket. When set to true,
 IP filter config validation will not apply.
      optional bool allow_all_service_agent_access = 5;
      Specified by:
      hasAllowAllServiceAgentAccess in interface Bucket.IpFilterOrBuilder
      Returns:
      Whether the allowAllServiceAgentAccess field is set.

    • getAllowAllServiceAgentAccess

      public boolean getAllowAllServiceAgentAccess()
       Whether or not to allow all P4SA access to the bucket. When set to true,
 IP filter config validation will not apply.
      optional bool allow_all_service_agent_access = 5;
      Specified by:
      getAllowAllServiceAgentAccess in interface Bucket.IpFilterOrBuilder
      Returns:
      The allowAllServiceAgentAccess.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Bucket.IpFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Bucket.IpFilter parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Bucket.IpFilter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Bucket.IpFilter parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Bucket.IpFilter parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Bucket.IpFilter parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Bucket.IpFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Bucket.IpFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Bucket.IpFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Bucket.IpFilter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Bucket.IpFilter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Bucket.IpFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Bucket.IpFilter.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Bucket.IpFilter.Builder newBuilder()

    • newBuilder

      public static Bucket.IpFilter.Builder newBuilder(Bucket.IpFilter prototype)

    • toBuilder

      public Bucket.IpFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Bucket.IpFilter.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Bucket.IpFilter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Bucket.IpFilter> parser()

    • getParserForType

      public com.google.protobuf.Parser<Bucket.IpFilter> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Bucket.IpFilter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder