Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/google-cloud-parallelstore/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from .types.parallelstore import (
CreateInstanceRequest,
DeleteInstanceRequest,
DeploymentType,
DestinationGcsBucket,
DestinationParallelstore,
DirectoryStripeLevel,
Expand All @@ -40,6 +41,8 @@
SourceGcsBucket,
SourceParallelstore,
TransferCounters,
TransferErrorLogEntry,
TransferErrorSummary,
TransferOperationMetadata,
TransferType,
UpdateInstanceRequest,
Expand All @@ -49,6 +52,7 @@
"ParallelstoreAsyncClient",
"CreateInstanceRequest",
"DeleteInstanceRequest",
"DeploymentType",
"DestinationGcsBucket",
"DestinationParallelstore",
"DirectoryStripeLevel",
Expand All @@ -68,6 +72,8 @@
"SourceGcsBucket",
"SourceParallelstore",
"TransferCounters",
"TransferErrorLogEntry",
"TransferErrorSummary",
"TransferOperationMetadata",
"TransferType",
"UpdateInstanceRequest",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from .parallelstore import (
CreateInstanceRequest,
DeleteInstanceRequest,
DeploymentType,
DestinationGcsBucket,
DestinationParallelstore,
DirectoryStripeLevel,
Expand All @@ -34,6 +35,8 @@
SourceGcsBucket,
SourceParallelstore,
TransferCounters,
TransferErrorLogEntry,
TransferErrorSummary,
TransferOperationMetadata,
TransferType,
UpdateInstanceRequest,
Expand All @@ -58,8 +61,11 @@
"SourceGcsBucket",
"SourceParallelstore",
"TransferCounters",
"TransferErrorLogEntry",
"TransferErrorSummary",
"TransferOperationMetadata",
"UpdateInstanceRequest",
"DeploymentType",
"DirectoryStripeLevel",
"FileStripeLevel",
"TransferType",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -27,6 +28,7 @@
"TransferType",
"FileStripeLevel",
"DirectoryStripeLevel",
"DeploymentType",
"Instance",
"ListInstancesRequest",
"ListInstancesResponse",
Expand All @@ -42,6 +44,8 @@
"ImportDataRequest",
"ExportDataRequest",
"ImportDataResponse",
"TransferErrorLogEntry",
"TransferErrorSummary",
"ImportDataMetadata",
"ExportDataResponse",
"ExportDataMetadata",
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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):
Expand All @@ -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,
Expand Down Expand Up @@ -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):
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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):
Expand Down Expand Up @@ -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(
Expand All @@ -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))
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Loading
Loading