Skip to content

Commit 03649eb

Browse files
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>
1 parent 7fb3f49 commit 03649eb

File tree

11 files changed

+226
-13
lines changed

11 files changed

+226
-13
lines changed

packages/google-cloud-parallelstore/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ In order to use this library, you first need to go through the following steps:
2626
1. `Select or create a Cloud Platform project.`_
2727
2. `Enable billing for your project.`_
2828
3. `Enable the Parallelstore API.`_
29-
4. `Setup Authentication.`_
29+
4. `Set up Authentication.`_
3030

3131
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
3232
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
3333
.. _Enable the Parallelstore API.: https://cloud.google.com/parallelstore
34-
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
34+
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
3535

3636
Installation
3737
~~~~~~~~~~~~

packages/google-cloud-parallelstore/google/cloud/parallelstore/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.2.10" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
from .types.parallelstore import (
2323
CreateInstanceRequest,
2424
DeleteInstanceRequest,
25+
DeploymentType,
2526
DestinationGcsBucket,
2627
DestinationParallelstore,
2728
DirectoryStripeLevel,
@@ -40,6 +41,8 @@
4041
SourceGcsBucket,
4142
SourceParallelstore,
4243
TransferCounters,
44+
TransferErrorLogEntry,
45+
TransferErrorSummary,
4346
TransferOperationMetadata,
4447
TransferType,
4548
UpdateInstanceRequest,
@@ -49,6 +52,7 @@
4952
"ParallelstoreAsyncClient",
5053
"CreateInstanceRequest",
5154
"DeleteInstanceRequest",
55+
"DeploymentType",
5256
"DestinationGcsBucket",
5357
"DestinationParallelstore",
5458
"DirectoryStripeLevel",
@@ -68,6 +72,8 @@
6872
"SourceGcsBucket",
6973
"SourceParallelstore",
7074
"TransferCounters",
75+
"TransferErrorLogEntry",
76+
"TransferErrorSummary",
7177
"TransferOperationMetadata",
7278
"TransferType",
7379
"UpdateInstanceRequest",

packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.2.10" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/types/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
from .parallelstore import (
1717
CreateInstanceRequest,
1818
DeleteInstanceRequest,
19+
DeploymentType,
1920
DestinationGcsBucket,
2021
DestinationParallelstore,
2122
DirectoryStripeLevel,
@@ -34,6 +35,8 @@
3435
SourceGcsBucket,
3536
SourceParallelstore,
3637
TransferCounters,
38+
TransferErrorLogEntry,
39+
TransferErrorSummary,
3740
TransferOperationMetadata,
3841
TransferType,
3942
UpdateInstanceRequest,
@@ -58,8 +61,11 @@
5861
"SourceGcsBucket",
5962
"SourceParallelstore",
6063
"TransferCounters",
64+
"TransferErrorLogEntry",
65+
"TransferErrorSummary",
6166
"TransferOperationMetadata",
6267
"UpdateInstanceRequest",
68+
"DeploymentType",
6369
"DirectoryStripeLevel",
6470
"FileStripeLevel",
6571
"TransferType",

packages/google-cloud-parallelstore/google/cloud/parallelstore_v1/types/parallelstore.py

Lines changed: 119 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
from google.protobuf import field_mask_pb2 # type: ignore
2121
from google.protobuf import timestamp_pb2 # type: ignore
22+
from google.rpc import code_pb2 # type: ignore
2223
import proto # type: ignore
2324

2425
__protobuf__ = proto.module(
@@ -27,6 +28,7 @@
2728
"TransferType",
2829
"FileStripeLevel",
2930
"DirectoryStripeLevel",
31+
"DeploymentType",
3032
"Instance",
3133
"ListInstancesRequest",
3234
"ListInstancesResponse",
@@ -42,6 +44,8 @@
4244
"ImportDataRequest",
4345
"ExportDataRequest",
4446
"ImportDataResponse",
47+
"TransferErrorLogEntry",
48+
"TransferErrorSummary",
4549
"ImportDataMetadata",
4650
"ExportDataResponse",
4751
"ExportDataMetadata",
@@ -107,6 +111,23 @@ class DirectoryStripeLevel(proto.Enum):
107111
DIRECTORY_STRIPE_LEVEL_MAX = 3
108112

109113

114+
class DeploymentType(proto.Enum):
115+
r"""Represents the deployment type for the instance.
116+
117+
Values:
118+
DEPLOYMENT_TYPE_UNSPECIFIED (0):
119+
Default Deployment Type
120+
It is equivalent to SCRATCH
121+
SCRATCH (1):
122+
Scratch
123+
PERSISTENT (2):
124+
Persistent
125+
"""
126+
DEPLOYMENT_TYPE_UNSPECIFIED = 0
127+
SCRATCH = 1
128+
PERSISTENT = 2
129+
130+
110131
class Instance(proto.Message):
111132
r"""A Parallelstore instance.
112133
@@ -139,8 +160,8 @@ class Instance(proto.Message):
139160
between 12000 and 100000, in multiples of 4000;
140161
e.g., 12000, 16000, 20000, ...
141162
daos_version (str):
142-
Output only. The version of DAOS software
143-
running in the instance.
163+
Deprecated 'daos_version' field. Output only. The version of
164+
DAOS software running in the instance.
144165
access_points (MutableSequence[str]):
145166
Output only. A list of IPv4 addresses used
146167
for client side configuration.
@@ -160,7 +181,8 @@ class Instance(proto.Message):
160181
and contains the value currently used by the
161182
service.
162183
file_stripe_level (google.cloud.parallelstore_v1.types.FileStripeLevel):
163-
Optional. Stripe level for files. Allowed values are:
184+
Optional. Immutable. Stripe level for files. Allowed values
185+
are:
164186
165187
- ``FILE_STRIPE_LEVEL_MIN``: offers the best performance
166188
for small size files.
@@ -169,7 +191,8 @@ class Instance(proto.Message):
169191
- ``FILE_STRIPE_LEVEL_MAX``: higher throughput performance
170192
for larger files.
171193
directory_stripe_level (google.cloud.parallelstore_v1.types.DirectoryStripeLevel):
172-
Optional. Stripe level for directories. Allowed values are:
194+
Optional. Immutable. Stripe level for directories. Allowed
195+
values are:
173196
174197
- ``DIRECTORY_STRIPE_LEVEL_MIN``: recommended when
175198
directories contain a small number of files.
@@ -178,6 +201,12 @@ class Instance(proto.Message):
178201
directories.
179202
- ``DIRECTORY_STRIPE_LEVEL_MAX``: recommended for
180203
directories with a large number of files.
204+
deployment_type (google.cloud.parallelstore_v1.types.DeploymentType):
205+
Optional. Immutable. The deployment type of the instance.
206+
Allowed values are:
207+
208+
- ``SCRATCH``: the instance is a scratch instance.
209+
- ``PERSISTENT``: the instance is a persistent instance.
181210
"""
182211

183212
class State(proto.Enum):
@@ -196,13 +225,17 @@ class State(proto.Enum):
196225
The instance is not usable.
197226
UPGRADING (5):
198227
The instance is being upgraded.
228+
REPAIRING (6):
229+
The instance is being repaired. This should only be used by
230+
instances using the ``PERSISTENT`` deployment type.
199231
"""
200232
STATE_UNSPECIFIED = 0
201233
CREATING = 1
202234
ACTIVE = 2
203235
DELETING = 3
204236
FAILED = 4
205237
UPGRADING = 5
238+
REPAIRING = 6
206239

207240
name: str = proto.Field(
208241
proto.STRING,
@@ -266,6 +299,11 @@ class State(proto.Enum):
266299
number=16,
267300
enum="DirectoryStripeLevel",
268301
)
302+
deployment_type: "DeploymentType" = proto.Field(
303+
proto.ENUM,
304+
number=17,
305+
enum="DeploymentType",
306+
)
269307

270308

271309
class ListInstancesRequest(proto.Message):
@@ -792,6 +830,60 @@ class ImportDataResponse(proto.Message):
792830
r"""The response to a request to import data to Parallelstore."""
793831

794832

833+
class TransferErrorLogEntry(proto.Message):
834+
r"""An entry describing an error that has occurred.
835+
836+
Attributes:
837+
uri (str):
838+
A URL that refers to the target (a data
839+
source, a data sink, or an object) with which
840+
the error is associated.
841+
error_details (MutableSequence[str]):
842+
A list of messages that carry the error
843+
details.
844+
"""
845+
846+
uri: str = proto.Field(
847+
proto.STRING,
848+
number=1,
849+
)
850+
error_details: MutableSequence[str] = proto.RepeatedField(
851+
proto.STRING,
852+
number=2,
853+
)
854+
855+
856+
class TransferErrorSummary(proto.Message):
857+
r"""A summary of errors by error code, plus a count and sample
858+
error log entries.
859+
860+
Attributes:
861+
error_code (google.rpc.code_pb2.Code):
862+
One of the error codes that caused the
863+
transfer failure.
864+
error_count (int):
865+
Count of this type of error.
866+
error_log_entries (MutableSequence[google.cloud.parallelstore_v1.types.TransferErrorLogEntry]):
867+
A list of messages that carry the error
868+
details.
869+
"""
870+
871+
error_code: code_pb2.Code = proto.Field(
872+
proto.ENUM,
873+
number=1,
874+
enum=code_pb2.Code,
875+
)
876+
error_count: int = proto.Field(
877+
proto.INT64,
878+
number=2,
879+
)
880+
error_log_entries: MutableSequence["TransferErrorLogEntry"] = proto.RepeatedField(
881+
proto.MESSAGE,
882+
number=4,
883+
message="TransferErrorLogEntry",
884+
)
885+
886+
795887
class ImportDataMetadata(proto.Message):
796888
r"""Metadata related to the data import operation.
797889
@@ -968,6 +1060,10 @@ class TransferOperationMetadata(proto.Message):
9681060
operation.
9691061
transfer_type (google.cloud.parallelstore_v1.types.TransferType):
9701062
Output only. The type of transfer occurring.
1063+
error_summary (MutableSequence[google.cloud.parallelstore_v1.types.TransferErrorSummary]):
1064+
Output only. List of files that failed to be
1065+
transferred. This list will have a maximum size
1066+
of 5 elements.
9711067
"""
9721068

9731069
source_parallelstore: "SourceParallelstore" = proto.Field(
@@ -1004,6 +1100,11 @@ class TransferOperationMetadata(proto.Message):
10041100
number=6,
10051101
enum="TransferType",
10061102
)
1103+
error_summary: MutableSequence["TransferErrorSummary"] = proto.RepeatedField(
1104+
proto.MESSAGE,
1105+
number=13,
1106+
message="TransferErrorSummary",
1107+
)
10071108

10081109

10091110
class TransferCounters(proto.Message):
@@ -1035,6 +1136,12 @@ class TransferCounters(proto.Message):
10351136
bytes_copied (int):
10361137
Bytes that are copied to the data
10371138
destination.
1139+
objects_failed (int):
1140+
Objects that failed to write to the data
1141+
destination.
1142+
bytes_failed (int):
1143+
Number of Bytes that failed to be written to
1144+
the data destination.
10381145
"""
10391146

10401147
objects_found: int = proto.Field(
@@ -1061,6 +1168,14 @@ class TransferCounters(proto.Message):
10611168
proto.INT64,
10621169
number=6,
10631170
)
1171+
objects_failed: int = proto.Field(
1172+
proto.INT64,
1173+
number=7,
1174+
)
1175+
bytes_failed: int = proto.Field(
1176+
proto.INT64,
1177+
number=8,
1178+
)
10641179

10651180

10661181
__all__ = tuple(sorted(__protobuf__.manifest))

packages/google-cloud-parallelstore/google/cloud/parallelstore_v1beta/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.2.10" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

0 commit comments

Comments
 (0)