feat: [google-cloud-parallelstore] deprecating daos_version field (#…

…13528) BEGIN_COMMIT_OVERRIDE feat: deprecating `daos_version` field feat: Adding `deployment_type` field docs: updated documentation for field `daos_version` in message `.google.cloud.parallelstore.v1.Instance` to reflect that the field is deprecated. docs: Updated field `file_stripe_level` in message `.google.cloud.parallelstore.v1.Instance` to reflected that message is now immutable docs: updated `directory_stripe_level` in message `.google.cloud.parallelstore.v1.Instance` to reflect that the field is now immutable END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. feat: Adding `deployment_type` field docs: updated documentation for field `daos_version` in message `.google.cloud.parallelstore.v1.Instance` to reflect that the field is deprecated. docs: Updated field `file_stripe_level` in message `.google.cloud.parallelstore.v1.Instance` to reflected that message is now immutable docs: updated `directory_stripe_level` in message `.google.cloud.parallelstore.v1.Instance` to reflect that the field is now immutable PiperOrigin-RevId: 726614548 Source-Link: googleapis/googleapis@a003cab Source-Link: googleapis/googleapis-gen@0987b56 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXBhcmFsbGVsc3RvcmUvLk93bEJvdC55YW1sIiwiaCI6IjA5ODdiNTYwYTAzY2NjOTcyMDI5MTlkMzI5MDA0ODgzN2YyYWU2ZDIifQ== --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Feb 18, 2025 · 03649eb · 03649eb
1 parent 7fb3f49
commit 03649eb
Show file tree

Hide file tree

Showing 11 changed files with 226 additions and 13 deletions.
diff --git a/packages/google-cloud-parallelstore/README.rst b/packages/google-cloud-parallelstore/README.rst
@@ -26,12 +26,12 @@ In order to use this library, you first need to go through the following steps:
 1. `Select or create a Cloud Platform project.`_
 2. `Enable billing for your project.`_
 3. `Enable the Parallelstore API.`_
-4. `Setup Authentication.`_
+4. `Set up Authentication.`_
 
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
 .. _Enable the Parallelstore API.:  https://cloud.google.com/parallelstore
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~

diff --git a/packages/google-cloud-parallelstore/google/cloud/parallelstore/gapic_version.py b/packages/google-cloud-parallelstore/google/cloud/parallelstore/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.2.10"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/__init__.py b/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/__init__.py
@@ -22,6 +22,7 @@
 from .types.parallelstore import (
     CreateInstanceRequest,
     DeleteInstanceRequest,
+    DeploymentType,
     DestinationGcsBucket,
     DestinationParallelstore,
     DirectoryStripeLevel,
@@ -40,6 +41,8 @@
     SourceGcsBucket,
     SourceParallelstore,
     TransferCounters,
+    TransferErrorLogEntry,
+    TransferErrorSummary,
     TransferOperationMetadata,
     TransferType,
     UpdateInstanceRequest,
@@ -49,6 +52,7 @@
     "ParallelstoreAsyncClient",
     "CreateInstanceRequest",
     "DeleteInstanceRequest",
+    "DeploymentType",
     "DestinationGcsBucket",
     "DestinationParallelstore",
     "DirectoryStripeLevel",
@@ -68,6 +72,8 @@
     "SourceGcsBucket",
     "SourceParallelstore",
     "TransferCounters",
+    "TransferErrorLogEntry",
+    "TransferErrorSummary",
     "TransferOperationMetadata",
     "TransferType",
     "UpdateInstanceRequest",

diff --git a/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/gapic_version.py b/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.2.10"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}
diff --git a/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/types/__init__.py b/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/types/__init__.py
@@ -16,6 +16,7 @@
 from .parallelstore import (
     CreateInstanceRequest,
     DeleteInstanceRequest,
+    DeploymentType,
     DestinationGcsBucket,
     DestinationParallelstore,
     DirectoryStripeLevel,
@@ -34,6 +35,8 @@
     SourceGcsBucket,
     SourceParallelstore,
     TransferCounters,
+    TransferErrorLogEntry,
+    TransferErrorSummary,
     TransferOperationMetadata,
     TransferType,
     UpdateInstanceRequest,
@@ -58,8 +61,11 @@
     "SourceGcsBucket",
     "SourceParallelstore",
     "TransferCounters",
+    "TransferErrorLogEntry",
+    "TransferErrorSummary",
     "TransferOperationMetadata",
     "UpdateInstanceRequest",
+    "DeploymentType",
     "DirectoryStripeLevel",
     "FileStripeLevel",
     "TransferType",

diff --git a/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/types/parallelstore.py b/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/types/parallelstore.py
@@ -19,6 +19,7 @@
 
 from google.protobuf import field_mask_pb2  # type: ignore
 from google.protobuf import timestamp_pb2  # type: ignore
+from google.rpc import code_pb2  # type: ignore
 import proto  # type: ignore
 
 __protobuf__ = proto.module(
@@ -27,6 +28,7 @@
         "TransferType",
         "FileStripeLevel",
         "DirectoryStripeLevel",
+        "DeploymentType",
         "Instance",
         "ListInstancesRequest",
         "ListInstancesResponse",
@@ -42,6 +44,8 @@
         "ImportDataRequest",
         "ExportDataRequest",
         "ImportDataResponse",
+        "TransferErrorLogEntry",
+        "TransferErrorSummary",
         "ImportDataMetadata",
         "ExportDataResponse",
         "ExportDataMetadata",
@@ -107,6 +111,23 @@ class DirectoryStripeLevel(proto.Enum):
     DIRECTORY_STRIPE_LEVEL_MAX = 3
 
 
+class DeploymentType(proto.Enum):
+    r"""Represents the deployment type for the instance.
+
+    Values:
+        DEPLOYMENT_TYPE_UNSPECIFIED (0):
+            Default Deployment Type
+            It is equivalent to SCRATCH
+        SCRATCH (1):
+            Scratch
+        PERSISTENT (2):
+            Persistent
+    """
+    DEPLOYMENT_TYPE_UNSPECIFIED = 0
+    SCRATCH = 1
+    PERSISTENT = 2
+
+
 class Instance(proto.Message):
     r"""A Parallelstore instance.
 
@@ -139,8 +160,8 @@ class Instance(proto.Message):
             between 12000 and 100000, in multiples of 4000;
             e.g., 12000, 16000, 20000, ...
         daos_version (str):
-            Output only. The version of DAOS software
-            running in the instance.
+            Deprecated 'daos_version' field. Output only. The version of
+            DAOS software running in the instance.
         access_points (MutableSequence[str]):
             Output only. A list of IPv4 addresses used
             for client side configuration.
@@ -160,7 +181,8 @@ class Instance(proto.Message):
             and contains the value currently used by the
             service.
         file_stripe_level (google.cloud.parallelstore_v1.types.FileStripeLevel):
-            Optional. Stripe level for files. Allowed values are:
+            Optional. Immutable. Stripe level for files. Allowed values
+            are:
 
             -  ``FILE_STRIPE_LEVEL_MIN``: offers the best performance
                for small size files.
@@ -169,7 +191,8 @@ class Instance(proto.Message):
             -  ``FILE_STRIPE_LEVEL_MAX``: higher throughput performance
                for larger files.
         directory_stripe_level (google.cloud.parallelstore_v1.types.DirectoryStripeLevel):
-            Optional. Stripe level for directories. Allowed values are:
+            Optional. Immutable. Stripe level for directories. Allowed
+            values are:
 
             -  ``DIRECTORY_STRIPE_LEVEL_MIN``: recommended when
                directories contain a small number of files.
@@ -178,6 +201,12 @@ class Instance(proto.Message):
                directories.
             -  ``DIRECTORY_STRIPE_LEVEL_MAX``: recommended for
                directories with a large number of files.
+        deployment_type (google.cloud.parallelstore_v1.types.DeploymentType):
+            Optional. Immutable. The deployment type of the instance.
+            Allowed values are:
+
+            -  ``SCRATCH``: the instance is a scratch instance.
+            -  ``PERSISTENT``: the instance is a persistent instance.
     """
 
     class State(proto.Enum):
@@ -196,13 +225,17 @@ class State(proto.Enum):
                 The instance is not usable.
             UPGRADING (5):
                 The instance is being upgraded.
+            REPAIRING (6):
+                The instance is being repaired. This should only be used by
+                instances using the ``PERSISTENT`` deployment type.
         """
         STATE_UNSPECIFIED = 0
         CREATING = 1
         ACTIVE = 2
         DELETING = 3
         FAILED = 4
         UPGRADING = 5
+        REPAIRING = 6
 
     name: str = proto.Field(
         proto.STRING,
@@ -266,6 +299,11 @@ class State(proto.Enum):
         number=16,
         enum="DirectoryStripeLevel",
     )
+    deployment_type: "DeploymentType" = proto.Field(
+        proto.ENUM,
+        number=17,
+        enum="DeploymentType",
+    )
 
 
 class ListInstancesRequest(proto.Message):
@@ -792,6 +830,60 @@ class ImportDataResponse(proto.Message):
     r"""The response to a request to import data to Parallelstore."""
 
 
+class TransferErrorLogEntry(proto.Message):
+    r"""An entry describing an error that has occurred.
+
+    Attributes:
+        uri (str):
+            A URL that refers to the target (a data
+            source, a data sink, or an object) with which
+            the error is associated.
+        error_details (MutableSequence[str]):
+            A list of messages that carry the error
+            details.
+    """
+
+    uri: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    error_details: MutableSequence[str] = proto.RepeatedField(
+        proto.STRING,
+        number=2,
+    )
+
+
+class TransferErrorSummary(proto.Message):
+    r"""A summary of errors by error code, plus a count and sample
+    error log entries.
+
+    Attributes:
+        error_code (google.rpc.code_pb2.Code):
+            One of the error codes that caused the
+            transfer failure.
+        error_count (int):
+            Count of this type of error.
+        error_log_entries (MutableSequence[google.cloud.parallelstore_v1.types.TransferErrorLogEntry]):
+            A list of messages that carry the error
+            details.
+    """
+
+    error_code: code_pb2.Code = proto.Field(
+        proto.ENUM,
+        number=1,
+        enum=code_pb2.Code,
+    )
+    error_count: int = proto.Field(
+        proto.INT64,
+        number=2,
+    )
+    error_log_entries: MutableSequence["TransferErrorLogEntry"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=4,
+        message="TransferErrorLogEntry",
+    )
+
+
 class ImportDataMetadata(proto.Message):
     r"""Metadata related to the data import operation.
 
@@ -968,6 +1060,10 @@ class TransferOperationMetadata(proto.Message):
             operation.
         transfer_type (google.cloud.parallelstore_v1.types.TransferType):
             Output only. The type of transfer occurring.
+        error_summary (MutableSequence[google.cloud.parallelstore_v1.types.TransferErrorSummary]):
+            Output only. List of files that failed to be
+            transferred. This list will have a maximum size
+            of 5 elements.
     """
 
     source_parallelstore: "SourceParallelstore" = proto.Field(
@@ -1004,6 +1100,11 @@ class TransferOperationMetadata(proto.Message):
         number=6,
         enum="TransferType",
     )
+    error_summary: MutableSequence["TransferErrorSummary"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=13,
+        message="TransferErrorSummary",
+    )
 
 
 class TransferCounters(proto.Message):
@@ -1035,6 +1136,12 @@ class TransferCounters(proto.Message):
         bytes_copied (int):
             Bytes that are copied to the data
             destination.
+        objects_failed (int):
+            Objects that failed to write to the data
+            destination.
+        bytes_failed (int):
+            Number of Bytes that failed to be written to
+            the data destination.
     """
 
     objects_found: int = proto.Field(
@@ -1061,6 +1168,14 @@ class TransferCounters(proto.Message):
         proto.INT64,
         number=6,
     )
+    objects_failed: int = proto.Field(
+        proto.INT64,
+        number=7,
+    )
+    bytes_failed: int = proto.Field(
+        proto.INT64,
+        number=8,
+    )
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))
diff --git a/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1beta/gapic_version.py b/packages/google-cloud-parallelstore/google/cloud/parallelstore_v1beta/gapic_version.py
@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.2.10"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}