google-cloud-storage 3.2.0__tar.gz → 3.3.0__tar.gz

{google_cloud_storage-3.2.0/google_cloud_storage.egg-info → google_cloud_storage-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-storage
-Version: 3.2.0
+Version: 3.3.0
 Summary: Google Cloud Storage API client library
 Home-page: https://github.com/googleapis/python-storage
 Author: Google LLC

{google_cloud_storage-3.2.0 → google_cloud_storage-3.3.0}/google/cloud/storage/bucket.py

@@ -56,6 +56,7 @@ from google.cloud.storage.constants import PUBLIC_ACCESS_PREVENTION_INHERITED
 from google.cloud.storage.constants import REGIONAL_LEGACY_STORAGE_CLASS
 from google.cloud.storage.constants import REGION_LOCATION_TYPE
 from google.cloud.storage.constants import STANDARD_STORAGE_CLASS
+from google.cloud.storage.ip_filter import IPFilter
 from google.cloud.storage.notification import BucketNotification
 from google.cloud.storage.notification import NONE_PAYLOAD_FORMAT
 from google.cloud.storage.retry import DEFAULT_RETRY
@@ -88,6 +89,7 @@ _LOCATION_SETTER_MESSAGE = (
 _FROM_STRING_MESSAGE = (
     "Bucket.from_string() is deprecated. " "Use Bucket.from_uri() instead."
 )
+_IP_FILTER_PROPERTY = "ipFilter"
 
 
 def _blobs_page_start(iterator, page, response):
@@ -2255,10 +2257,7 @@ class Bucket(_PropertyMixin):
         timeout=_DEFAULT_TIMEOUT,
         retry=DEFAULT_RETRY_IF_GENERATION_SPECIFIED,
     ):
-        """Move a blob to a new name within a single HNS bucket.
-
-        *This feature is currently only supported for HNS (Heirarchical
-        Namespace) buckets.*
+        """Move a blob to a new name atomically.
 
         If :attr:`user_project` is set on the bucket, bills the API request to that project.
 
@@ -3890,6 +3889,59 @@ class Bucket(_PropertyMixin):
             query_parameters=query_parameters,
         )
 
+    @property
+    def ip_filter(self):
+        """Retrieve or set the IP Filter configuration for this bucket.
+
+        See https://cloud.google.com/storage/docs/ip-filtering-overview and
+        https://cloud.google.com/storage/docs/json_api/v1/buckets#ipFilter
+
+        .. note::
+            The getter for this property returns an
+            :class:`~google.cloud.storage.ip_filter.IPFilter` object, which is a
+            structured representation of the bucket's IP filter configuration.
+            Modifying the returned object has no effect. To update the bucket's
+            IP filter, create and assign a new ``IPFilter`` object to this
+            property and then call
+            :meth:`~google.cloud.storage.bucket.Bucket.patch`.
+
+            .. code-block:: python
+
+                from google.cloud.storage.ip_filter import (
+                    IPFilter,
+                    PublicNetworkSource,
+                )
+
+                ip_filter = IPFilter()
+                ip_filter.mode = "Enabled"
+                ip_filter.public_network_source = PublicNetworkSource(
+                    allowed_ip_cidr_ranges=["203.0.113.5/32"]
+                )
+                bucket.ip_filter = ip_filter
+                bucket.patch()
+
+        :setter: Set the IP Filter configuration for this bucket.
+        :getter: Gets the IP Filter configuration for this bucket.
+
+        :rtype: :class:`~google.cloud.storage.ip_filter.IPFilter` or ``NoneType``
+        :returns:
+            An ``IPFilter`` object representing the configuration, or ``None``
+            if no filter is configured.
+        """
+        resource = self._properties.get(_IP_FILTER_PROPERTY)
+        if resource:
+            return IPFilter._from_api_resource(resource)
+        return None
+
+    @ip_filter.setter
+    def ip_filter(self, value):
+        if value is None:
+            self._patch_property(_IP_FILTER_PROPERTY, None)
+        elif isinstance(value, IPFilter):
+            self._patch_property(_IP_FILTER_PROPERTY, value._to_api_resource())
+        else:
+            self._patch_property(_IP_FILTER_PROPERTY, value)
+
 
 class SoftDeletePolicy(dict):
     """Map a bucket's soft delete policy.

google_cloud_storage-3.3.0/google/cloud/storage/ip_filter.py

@@ -0,0 +1,143 @@
+# Copyright 2014 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""IP Filter configuration for Google Cloud Storage Buckets."""
+
+from typing import Dict, Any, Optional, List
+
+_MODE = "mode"
+_PUBLIC_NETWORK_SOURCE = "publicNetworkSource"
+_VPC_NETWORK_SOURCES = "vpcNetworkSources"
+_ALLOWED_IP_CIDR_RANGES = "allowedIpCidrRanges"
+_NETWORK = "network"
+_ALLOW_ALL_SERVICE_AGENT_ACCESS = "allowAllServiceAgentAccess"
+_ALLOW_CROSS_ORG_VPCS = "allowCrossOrgVpcs"
+
+
+class PublicNetworkSource:
+    """Represents a public network source for a GCS Bucket IP Filter.
+
+    :type allowed_ip_cidr_ranges: list(str) or None
+    :param allowed_ip_cidr_ranges: A list of public IPv4 or IPv6 ranges in
+                                   CIDR notation that are allowed to access
+                                   the bucket.
+    """
+
+    def __init__(self, allowed_ip_cidr_ranges: Optional[List[str]] = None):
+        self.allowed_ip_cidr_ranges = allowed_ip_cidr_ranges or []
+
+    def _to_api_resource(self) -> Dict[str, Any]:
+        """Serializes this object to a dictionary for API requests."""
+        return {_ALLOWED_IP_CIDR_RANGES: self.allowed_ip_cidr_ranges}
+
+
+class VpcNetworkSource:
+    """Represents a VPC network source for a GCS Bucket IP Filter.
+
+    :type network: str
+    :param network: The resource name of the VPC network.
+
+    :type allowed_ip_cidr_ranges: list(str) or None
+    :param allowed_ip_cidr_ranges: A list of IPv4 or IPv6 ranges in CIDR
+                                   notation allowed to access the bucket
+                                   from this VPC.
+    """
+
+    def __init__(
+        self, network: str, allowed_ip_cidr_ranges: Optional[List[str]] = None
+    ):
+        self.network = network
+        self.allowed_ip_cidr_ranges = allowed_ip_cidr_ranges or []
+
+    def _to_api_resource(self) -> Dict[str, Any]:
+        """Serializes this object to a dictionary for API requests."""
+        return {
+            _NETWORK: self.network,
+            _ALLOWED_IP_CIDR_RANGES: self.allowed_ip_cidr_ranges,
+        }
+
+
+class IPFilter:
+    """Represents a GCS Bucket IP Filter configuration.
+
+    This class is a helper for constructing the IP Filter dictionary to be
+    assigned to a bucket's ``ip_filter`` property.
+    """
+
+    """
+    Attributes:
+        mode (str): Required. The mode of the IP filter. Can be "Enabled" or "Disabled".
+        allow_all_service_agent_access (bool): Required. If True, allows Google
+            Cloud service agents to bypass the IP filter.
+        public_network_source (PublicNetworkSource): (Optional) The configuration
+            for requests from the public internet.
+        vpc_network_sources (list(VpcNetworkSource)): (Optional) A list of
+            configurations for requests from VPC networks.
+        allow_cross_org_vpcs (bool): (Optional) If True, allows VPCs from
+            other organizations to be used in the configuration.
+    """
+
+    def __init__(self):
+        self.mode: Optional[str] = None
+        self.public_network_source: Optional[PublicNetworkSource] = None
+        self.vpc_network_sources: List[VpcNetworkSource] = []
+        self.allow_all_service_agent_access: Optional[bool] = None
+        self.allow_cross_org_vpcs: Optional[bool] = None
+
+    @classmethod
+    def _from_api_resource(cls, resource: Dict[str, Any]) -> "IPFilter":
+        """Factory: creates an IPFilter instance from a server response."""
+        ip_filter = cls()
+        ip_filter.mode = resource.get(_MODE)
+        ip_filter.allow_all_service_agent_access = resource.get(
+            _ALLOW_ALL_SERVICE_AGENT_ACCESS, None
+        )
+
+        public_network_source_data = resource.get(_PUBLIC_NETWORK_SOURCE, None)
+        if public_network_source_data:
+            ip_filter.public_network_source = PublicNetworkSource(
+                allowed_ip_cidr_ranges=public_network_source_data.get(
+                    _ALLOWED_IP_CIDR_RANGES, []
+                )
+            )
+
+        vns_res_list = resource.get(_VPC_NETWORK_SOURCES, [])
+        ip_filter.vpc_network_sources = [
+            VpcNetworkSource(
+                network=vns.get(_NETWORK),
+                allowed_ip_cidr_ranges=vns.get(_ALLOWED_IP_CIDR_RANGES, []),
+            )
+            for vns in vns_res_list
+        ]
+        ip_filter.allow_cross_org_vpcs = resource.get(_ALLOW_CROSS_ORG_VPCS, None)
+        return ip_filter
+
+    def _to_api_resource(self) -> Dict[str, Any]:
+        """Serializes this object to a dictionary for API requests."""
+        resource = {
+            _MODE: self.mode,
+            _ALLOW_ALL_SERVICE_AGENT_ACCESS: self.allow_all_service_agent_access,
+        }
+
+        if self.public_network_source:
+            resource[
+                _PUBLIC_NETWORK_SOURCE
+            ] = self.public_network_source._to_api_resource()
+        if self.vpc_network_sources is not None:
+            resource[_VPC_NETWORK_SOURCES] = [
+                vns._to_api_resource() for vns in self.vpc_network_sources
+            ]
+        if self.allow_cross_org_vpcs is not None:
+            resource[_ALLOW_CROSS_ORG_VPCS] = self.allow_cross_org_vpcs
+        return resource

{google_cloud_storage-3.2.0 → google_cloud_storage-3.3.0}/google/cloud/storage/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "3.2.0"
+__version__ = "3.3.0"

google_cloud_storage-3.3.0/google/cloud/storage_v2/__init__.py

@@ -0,0 +1,140 @@
+# -*- coding: utf-8 -*-
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+from google.cloud.storage_v2 import gapic_version as package_version
+
+__version__ = package_version.__version__
+
+
+from .services.storage import StorageClient
+from .services.storage import StorageAsyncClient
+
+from .types.storage import AppendObjectSpec
+from .types.storage import BidiReadHandle
+from .types.storage import BidiReadObjectError
+from .types.storage import BidiReadObjectRedirectedError
+from .types.storage import BidiReadObjectRequest
+from .types.storage import BidiReadObjectResponse
+from .types.storage import BidiReadObjectSpec
+from .types.storage import BidiWriteHandle
+from .types.storage import BidiWriteObjectRedirectedError
+from .types.storage import BidiWriteObjectRequest
+from .types.storage import BidiWriteObjectResponse
+from .types.storage import Bucket
+from .types.storage import BucketAccessControl
+from .types.storage import CancelResumableWriteRequest
+from .types.storage import CancelResumableWriteResponse
+from .types.storage import ChecksummedData
+from .types.storage import CommonObjectRequestParams
+from .types.storage import ComposeObjectRequest
+from .types.storage import ContentRange
+from .types.storage import CreateBucketRequest
+from .types.storage import CustomerEncryption
+from .types.storage import DeleteBucketRequest
+from .types.storage import DeleteObjectRequest
+from .types.storage import GetBucketRequest
+from .types.storage import GetObjectRequest
+from .types.storage import ListBucketsRequest
+from .types.storage import ListBucketsResponse
+from .types.storage import ListObjectsRequest
+from .types.storage import ListObjectsResponse
+from .types.storage import LockBucketRetentionPolicyRequest
+from .types.storage import MoveObjectRequest
+from .types.storage import Object
+from .types.storage import ObjectAccessControl
+from .types.storage import ObjectChecksums
+from .types.storage import ObjectContexts
+from .types.storage import ObjectCustomContextPayload
+from .types.storage import ObjectRangeData
+from .types.storage import Owner
+from .types.storage import ProjectTeam
+from .types.storage import QueryWriteStatusRequest
+from .types.storage import QueryWriteStatusResponse
+from .types.storage import ReadObjectRequest
+from .types.storage import ReadObjectResponse
+from .types.storage import ReadRange
+from .types.storage import ReadRangeError
+from .types.storage import RestoreObjectRequest
+from .types.storage import RewriteObjectRequest
+from .types.storage import RewriteResponse
+from .types.storage import ServiceConstants
+from .types.storage import StartResumableWriteRequest
+from .types.storage import StartResumableWriteResponse
+from .types.storage import UpdateBucketRequest
+from .types.storage import UpdateObjectRequest
+from .types.storage import WriteObjectRequest
+from .types.storage import WriteObjectResponse
+from .types.storage import WriteObjectSpec
+
+__all__ = (
+    "StorageAsyncClient",
+    "AppendObjectSpec",
+    "BidiReadHandle",
+    "BidiReadObjectError",
+    "BidiReadObjectRedirectedError",
+    "BidiReadObjectRequest",
+    "BidiReadObjectResponse",
+    "BidiReadObjectSpec",
+    "BidiWriteHandle",
+    "BidiWriteObjectRedirectedError",
+    "BidiWriteObjectRequest",
+    "BidiWriteObjectResponse",
+    "Bucket",
+    "BucketAccessControl",
+    "CancelResumableWriteRequest",
+    "CancelResumableWriteResponse",
+    "ChecksummedData",
+    "CommonObjectRequestParams",
+    "ComposeObjectRequest",
+    "ContentRange",
+    "CreateBucketRequest",
+    "CustomerEncryption",
+    "DeleteBucketRequest",
+    "DeleteObjectRequest",
+    "GetBucketRequest",
+    "GetObjectRequest",
+    "ListBucketsRequest",
+    "ListBucketsResponse",
+    "ListObjectsRequest",
+    "ListObjectsResponse",
+    "LockBucketRetentionPolicyRequest",
+    "MoveObjectRequest",
+    "Object",
+    "ObjectAccessControl",
+    "ObjectChecksums",
+    "ObjectContexts",
+    "ObjectCustomContextPayload",
+    "ObjectRangeData",
+    "Owner",
+    "ProjectTeam",
+    "QueryWriteStatusRequest",
+    "QueryWriteStatusResponse",
+    "ReadObjectRequest",
+    "ReadObjectResponse",
+    "ReadRange",
+    "ReadRangeError",
+    "RestoreObjectRequest",
+    "RewriteObjectRequest",
+    "RewriteResponse",
+    "ServiceConstants",
+    "StartResumableWriteRequest",
+    "StartResumableWriteResponse",
+    "StorageClient",
+    "UpdateBucketRequest",
+    "UpdateObjectRequest",
+    "WriteObjectRequest",
+    "WriteObjectResponse",
+    "WriteObjectSpec",
+)

google_cloud_storage-3.3.0/google/cloud/storage_v2/gapic_metadata.json

@@ -0,0 +1,263 @@
+ {
+  "comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
+  "language": "python",
+  "libraryPackage": "google.cloud.storage_v2",
+  "protoPackage": "google.storage.v2",
+  "schema": "1.0",
+  "services": {
+    "Storage": {
+      "clients": {
+        "grpc": {
+          "libraryClient": "StorageClient",
+          "rpcs": {
+            "BidiReadObject": {
+              "methods": [
+                "bidi_read_object"
+              ]
+            },
+            "BidiWriteObject": {
+              "methods": [
+                "bidi_write_object"
+              ]
+            },
+            "CancelResumableWrite": {
+              "methods": [
+                "cancel_resumable_write"
+              ]
+            },
+            "ComposeObject": {
+              "methods": [
+                "compose_object"
+              ]
+            },
+            "CreateBucket": {
+              "methods": [
+                "create_bucket"
+              ]
+            },
+            "DeleteBucket": {
+              "methods": [
+                "delete_bucket"
+              ]
+            },
+            "DeleteObject": {
+              "methods": [
+                "delete_object"
+              ]
+            },
+            "GetBucket": {
+              "methods": [
+                "get_bucket"
+              ]
+            },
+            "GetIamPolicy": {
+              "methods": [
+                "get_iam_policy"
+              ]
+            },
+            "GetObject": {
+              "methods": [
+                "get_object"
+              ]
+            },
+            "ListBuckets": {
+              "methods": [
+                "list_buckets"
+              ]
+            },
+            "ListObjects": {
+              "methods": [
+                "list_objects"
+              ]
+            },
+            "LockBucketRetentionPolicy": {
+              "methods": [
+                "lock_bucket_retention_policy"
+              ]
+            },
+            "MoveObject": {
+              "methods": [
+                "move_object"
+              ]
+            },
+            "QueryWriteStatus": {
+              "methods": [
+                "query_write_status"
+              ]
+            },
+            "ReadObject": {
+              "methods": [
+                "read_object"
+              ]
+            },
+            "RestoreObject": {
+              "methods": [
+                "restore_object"
+              ]
+            },
+            "RewriteObject": {
+              "methods": [
+                "rewrite_object"
+              ]
+            },
+            "SetIamPolicy": {
+              "methods": [
+                "set_iam_policy"
+              ]
+            },
+            "StartResumableWrite": {
+              "methods": [
+                "start_resumable_write"
+              ]
+            },
+            "TestIamPermissions": {
+              "methods": [
+                "test_iam_permissions"
+              ]
+            },
+            "UpdateBucket": {
+              "methods": [
+                "update_bucket"
+              ]
+            },
+            "UpdateObject": {
+              "methods": [
+                "update_object"
+              ]
+            },
+            "WriteObject": {
+              "methods": [
+                "write_object"
+              ]
+            }
+          }
+        },
+        "grpc-async": {
+          "libraryClient": "StorageAsyncClient",
+          "rpcs": {
+            "BidiReadObject": {
+              "methods": [
+                "bidi_read_object"
+              ]
+            },
+            "BidiWriteObject": {
+              "methods": [
+                "bidi_write_object"
+              ]
+            },
+            "CancelResumableWrite": {
+              "methods": [
+                "cancel_resumable_write"
+              ]
+            },
+            "ComposeObject": {
+              "methods": [
+                "compose_object"
+              ]
+            },
+            "CreateBucket": {
+              "methods": [
+                "create_bucket"
+              ]
+            },
+            "DeleteBucket": {
+              "methods": [
+                "delete_bucket"
+              ]
+            },
+            "DeleteObject": {
+              "methods": [
+                "delete_object"
+              ]
+            },
+            "GetBucket": {
+              "methods": [
+                "get_bucket"
+              ]
+            },
+            "GetIamPolicy": {
+              "methods": [
+                "get_iam_policy"
+              ]
+            },
+            "GetObject": {
+              "methods": [
+                "get_object"
+              ]
+            },
+            "ListBuckets": {
+              "methods": [
+                "list_buckets"
+              ]
+            },
+            "ListObjects": {
+              "methods": [
+                "list_objects"
+              ]
+            },
+            "LockBucketRetentionPolicy": {
+              "methods": [
+                "lock_bucket_retention_policy"
+              ]
+            },
+            "MoveObject": {
+              "methods": [
+                "move_object"
+              ]
+            },
+            "QueryWriteStatus": {
+              "methods": [
+                "query_write_status"
+              ]
+            },
+            "ReadObject": {
+              "methods": [
+                "read_object"
+              ]
+            },
+            "RestoreObject": {
+              "methods": [
+                "restore_object"
+              ]
+            },
+            "RewriteObject": {
+              "methods": [
+                "rewrite_object"
+              ]
+            },
+            "SetIamPolicy": {
+              "methods": [
+                "set_iam_policy"
+              ]
+            },
+            "StartResumableWrite": {
+              "methods": [
+                "start_resumable_write"
+              ]
+            },
+            "TestIamPermissions": {
+              "methods": [
+                "test_iam_permissions"
+              ]
+            },
+            "UpdateBucket": {
+              "methods": [
+                "update_bucket"
+              ]
+            },
+            "UpdateObject": {
+              "methods": [
+                "update_object"
+              ]
+            },
+            "WriteObject": {
+              "methods": [
+                "write_object"
+              ]
+            }
+          }
+        }
+      }
+    }
+  }
+}

google_cloud_storage-3.3.0/google/cloud/storage_v2/gapic_version.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+__version__ = "0.0.0"  # {x-release-please-version}

google_cloud_storage-3.3.0/google/cloud/storage_v2/py.typed

@@ -0,0 +1,2 @@
+# Marker file for PEP 561.
+# The google-cloud-storage package uses inline types.

google_cloud_storage-3.3.0/google/cloud/storage_v2/services/__init__.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#