Skip to content

Commit

Permalink
docs: [tpu] fix minor docstring formatting (#8920)
Browse files Browse the repository at this point in the history
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 495593544

Source-Link: https://togithub.com/googleapis/googleapis/commit/ea5238289be2ee79da957bfdd6c3e73e497d5bd1

Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/db6462edfe50c0b93f491e094e748f0daa61d398
Copy-Tag: eyJwIjoiamF2YS10cHUvLk93bEJvdC55YW1sIiwiaCI6ImRiNjQ2MmVkZmU1MGMwYjkzZjQ5MWUwOTRlNzQ4ZjBkYWE2MWQzOTgifQ==
  • Loading branch information
gcf-owl-bot[bot] committed Dec 20, 2022
1 parent 91aac16 commit 1ed54ab
Show file tree
Hide file tree
Showing 23 changed files with 204 additions and 162 deletions.
6 changes: 3 additions & 3 deletions java-tpu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-tpu</artifactId>
<version>2.7.0</version>
<version>2.8.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.cloud:google-cloud-tpu:2.7.0'
implementation 'com.google.cloud:google-cloud-tpu:2.8.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-tpu" % "2.7.0"
libraryDependencies += "com.google.cloud" % "google-cloud-tpu" % "2.8.0"
```

## Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1336,7 +1336,7 @@ public final UnaryCallable<GetQueuedResourceRequest, QueuedResource> getQueuedRe
*
* @param parent Required. The parent resource name.
* @param queuedResource Required. The queued resource.
* @param queuedResourceId The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* @param queuedResourceId The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -1374,7 +1374,7 @@ public final OperationFuture<QueuedResource, OperationMetadata> createQueuedReso
*
* @param parent Required. The parent resource name.
* @param queuedResource Required. The queued resource.
* @param queuedResourceId The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* @param queuedResourceId The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource].
* Request for
* [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.CreateQueuedResourceRequest}
Expand Down Expand Up @@ -128,7 +129,7 @@ public com.google.protobuf.ByteString getParentBytes() {
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand All @@ -152,7 +153,7 @@ public java.lang.String getQueuedResourceId() {
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand Down Expand Up @@ -472,7 +473,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource].
* Request for
* [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.CreateQueuedResourceRequest}
Expand Down Expand Up @@ -806,7 +808,7 @@ public Builder setParentBytes(com.google.protobuf.ByteString value) {
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand All @@ -829,7 +831,7 @@ public java.lang.String getQueuedResourceId() {
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand All @@ -852,7 +854,7 @@ public com.google.protobuf.ByteString getQueuedResourceIdBytes() {
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand All @@ -874,7 +876,7 @@ public Builder setQueuedResourceId(java.lang.String value) {
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand All @@ -892,7 +894,7 @@ public Builder clearQueuedResourceId() {
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public interface CreateQueuedResourceRequestOrBuilder
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand All @@ -69,7 +69,7 @@ public interface CreateQueuedResourceRequestOrBuilder
*
*
* <pre>
* The unqualified resource name. Should follow the ^[A-Za-z0-9_.~+%-]+$
* The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$`
* regex format.
* </pre>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource].
* Request for
* [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.DeleteQueuedResourceRequest}
Expand Down Expand Up @@ -343,7 +344,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource].
* Request for
* [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.DeleteQueuedResourceRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* Request for
* [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GenerateServiceIdentityRequest}
Expand Down Expand Up @@ -285,7 +286,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* Request for
* [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GenerateServiceIdentityRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Response for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* Response for
* [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse}
Expand Down Expand Up @@ -283,7 +284,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Response for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* Response for
* [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType].
* Request for
* [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetAcceleratorTypeRequest}
Expand Down Expand Up @@ -284,7 +285,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType].
* Request for
* [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetAcceleratorTypeRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* Request for
* [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetGuestAttributesRequest}
Expand Down Expand Up @@ -425,7 +426,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* Request for
* [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetGuestAttributesRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Response for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* Response for
* [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetGuestAttributesResponse}
Expand Down Expand Up @@ -303,7 +304,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Response for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* Response for
* [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetGuestAttributesResponse}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource]
* Request for
* [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource]
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetQueuedResourceRequest}
Expand Down Expand Up @@ -284,7 +285,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource]
* Request for
* [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource]
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetQueuedResourceRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion].
* Request for
* [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetRuntimeVersionRequest}
Expand Down Expand Up @@ -284,7 +285,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion].
* Request for
* [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.GetRuntimeVersionRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* Request for
* [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListAcceleratorTypesRequest}
Expand Down Expand Up @@ -488,7 +489,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* Request for
* [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListAcceleratorTypesRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Response for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* Response for
* [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse}
Expand Down Expand Up @@ -440,7 +441,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Response for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* Response for
* [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* Request for
* [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListQueuedResourcesRequest}
Expand Down Expand Up @@ -370,7 +371,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* Request for
* [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListQueuedResourcesRequest}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Response for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* Response for
* [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse}
Expand Down Expand Up @@ -440,7 +441,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Response for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* Response for
* [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].
* </pre>
*
* Protobuf type {@code google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse}
Expand Down
Loading

0 comments on commit 1ed54ab

Please sign in to comment.