Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit 3e0defe

Browse files
docs: Update documentation comments to match tone and style with the rest of Cloud documentation (#69)
This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/d04c2fb0-ffe0-420e-b55b-f8d549dbb501/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) PiperOrigin-RevId: 367097700 Source-Link: googleapis/googleapis@ddb4f28 feat: Adding customer level pubsub events for primary domain verification and primary domain change feat: Enabled support for boolean as an allowed parameter value feat: Added legacy_sku field to TransferableSku
1 parent a34fad1 commit 3e0defe

96 files changed

Lines changed: 5349 additions & 5311 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

google-cloud-channel/src/main/java/com/google/cloud/channel/v1/CloudChannelServiceClient.java

Lines changed: 885 additions & 922 deletions
Large diffs are not rendered by default.

google-cloud-channel/src/main/java/com/google/cloud/channel/v1/package-info.java

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,23 @@
1919
*
2020
* <p>======================= CloudChannelServiceClient =======================
2121
*
22-
* <p>Service Description: CloudChannelService enables Google cloud resellers and distributors to
23-
* manage their customers, channel partners, entitlements and reports.
22+
* <p>Service Description: CloudChannelService lets Google cloud resellers and distributors manage
23+
* their customers, channel partners, entitlements, and reports.
2424
*
25-
* <p>Using this service: 1. Resellers or distributors can manage a customer entity. 2. Distributors
26-
* can register an authorized reseller in their channel and then enable delegated admin access for
27-
* the reseller. 3. Resellers or distributors can manage entitlements for their customers.
25+
* <p>Using this service: 1. Resellers and distributors can manage a customer entity. 2.
26+
* Distributors can register an authorized reseller in their channel and provide them with delegated
27+
* admin access. 3. Resellers and distributors can manage customer entitlements.
2828
*
29-
* <p>The service primarily exposes the following resources: -
30-
* [Customer][google.cloud.channel.v1.Customer]s: A Customer represents an entity managed by a
31-
* reseller or distributor. A customer typically represents an enterprise. In an n-tier resale
32-
* channel hierarchy, customers are generally represented as leaf nodes. Customers primarily have an
33-
* Entitlement sub-resource discussed below.
29+
* <p>CloudChannelService exposes the following resources: -
30+
* [Customer][google.cloud.channel.v1.Customer]s: An entity?usually an enterprise?managed by a
31+
* reseller or distributor.
3432
*
35-
* <p>- [Entitlement][google.cloud.channel.v1.Entitlement]s: An Entitlement represents an entity
36-
* which provides a customer means to start using a service. Entitlements are created or updated as
37-
* a result of a successful fulfillment.
33+
* <p>- [Entitlement][google.cloud.channel.v1.Entitlement]s: An entity that provides a customer with
34+
* the means to use a service. Entitlements are created or updated as a result of a successful
35+
* fulfillment.
3836
*
39-
* <p>- [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: A ChannelPartnerLink is
40-
* an entity that identifies links between distributors and their indirect resellers in a channel.
37+
* <p>- [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies
38+
* links between distributors and their indirect resellers in a channel.
4139
*
4240
* <p>Sample for CloudChannelServiceClient:
4341
*

grpc-google-cloud-channel-v1/src/main/java/com/google/cloud/channel/v1/CloudChannelServiceGrpc.java

Lines changed: 1426 additions & 1632 deletions
Large diffs are not rendered by default.

proto-google-cloud-channel-v1/src/main/java/com/google/cloud/channel/v1/ActivateEntitlementRequest.java

Lines changed: 49 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
126126
*
127127
* <pre>
128128
* Required. The resource name of the entitlement to activate.
129-
* The name takes the format:
129+
* Name uses the format:
130130
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
131131
* </pre>
132132
*
@@ -151,7 +151,7 @@ public java.lang.String getName() {
151151
*
152152
* <pre>
153153
* Required. The resource name of the entitlement to activate.
154-
* The name takes the format:
154+
* Name uses the format:
155155
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
156156
* </pre>
157157
*
@@ -178,13 +178,12 @@ public com.google.protobuf.ByteString getNameBytes() {
178178
*
179179
*
180180
* <pre>
181-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
182-
* that if you must retry your request, the server will know to ignore the
183-
* request if it has already been completed.
184-
* For example, consider a situation where you make an initial request and
185-
* the request times out. If you make the request again with the same
186-
* request ID, the server can check if the original operation with the same
187-
* request ID was received, and if so, will ignore the second request.
181+
* Optional. You can specify an optional unique request ID, and if you need to retry
182+
* your request, the server will know to ignore the request if it's complete.
183+
* For example, you make an initial request and the request times out. If you
184+
* make the request again with the same request ID, the server can check if
185+
* it received the original operation with the same request ID. If it did, it
186+
* will ignore the second request.
188187
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
189188
* with the exception that zero UUID is not supported
190189
* (`00000000-0000-0000-0000-000000000000`).
@@ -210,13 +209,12 @@ public java.lang.String getRequestId() {
210209
*
211210
*
212211
* <pre>
213-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
214-
* that if you must retry your request, the server will know to ignore the
215-
* request if it has already been completed.
216-
* For example, consider a situation where you make an initial request and
217-
* the request times out. If you make the request again with the same
218-
* request ID, the server can check if the original operation with the same
219-
* request ID was received, and if so, will ignore the second request.
212+
* Optional. You can specify an optional unique request ID, and if you need to retry
213+
* your request, the server will know to ignore the request if it's complete.
214+
* For example, you make an initial request and the request times out. If you
215+
* make the request again with the same request ID, the server can check if
216+
* it received the original operation with the same request ID. If it did, it
217+
* will ignore the second request.
220218
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
221219
* with the exception that zero UUID is not supported
222220
* (`00000000-0000-0000-0000-000000000000`).
@@ -580,7 +578,7 @@ public Builder mergeFrom(
580578
*
581579
* <pre>
582580
* Required. The resource name of the entitlement to activate.
583-
* The name takes the format:
581+
* Name uses the format:
584582
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
585583
* </pre>
586584
*
@@ -604,7 +602,7 @@ public java.lang.String getName() {
604602
*
605603
* <pre>
606604
* Required. The resource name of the entitlement to activate.
607-
* The name takes the format:
605+
* Name uses the format:
608606
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
609607
* </pre>
610608
*
@@ -628,7 +626,7 @@ public com.google.protobuf.ByteString getNameBytes() {
628626
*
629627
* <pre>
630628
* Required. The resource name of the entitlement to activate.
631-
* The name takes the format:
629+
* Name uses the format:
632630
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
633631
* </pre>
634632
*
@@ -651,7 +649,7 @@ public Builder setName(java.lang.String value) {
651649
*
652650
* <pre>
653651
* Required. The resource name of the entitlement to activate.
654-
* The name takes the format:
652+
* Name uses the format:
655653
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
656654
* </pre>
657655
*
@@ -670,7 +668,7 @@ public Builder clearName() {
670668
*
671669
* <pre>
672670
* Required. The resource name of the entitlement to activate.
673-
* The name takes the format:
671+
* Name uses the format:
674672
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
675673
* </pre>
676674
*
@@ -695,13 +693,12 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) {
695693
*
696694
*
697695
* <pre>
698-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
699-
* that if you must retry your request, the server will know to ignore the
700-
* request if it has already been completed.
701-
* For example, consider a situation where you make an initial request and
702-
* the request times out. If you make the request again with the same
703-
* request ID, the server can check if the original operation with the same
704-
* request ID was received, and if so, will ignore the second request.
696+
* Optional. You can specify an optional unique request ID, and if you need to retry
697+
* your request, the server will know to ignore the request if it's complete.
698+
* For example, you make an initial request and the request times out. If you
699+
* make the request again with the same request ID, the server can check if
700+
* it received the original operation with the same request ID. If it did, it
701+
* will ignore the second request.
705702
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
706703
* with the exception that zero UUID is not supported
707704
* (`00000000-0000-0000-0000-000000000000`).
@@ -726,13 +723,12 @@ public java.lang.String getRequestId() {
726723
*
727724
*
728725
* <pre>
729-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
730-
* that if you must retry your request, the server will know to ignore the
731-
* request if it has already been completed.
732-
* For example, consider a situation where you make an initial request and
733-
* the request times out. If you make the request again with the same
734-
* request ID, the server can check if the original operation with the same
735-
* request ID was received, and if so, will ignore the second request.
726+
* Optional. You can specify an optional unique request ID, and if you need to retry
727+
* your request, the server will know to ignore the request if it's complete.
728+
* For example, you make an initial request and the request times out. If you
729+
* make the request again with the same request ID, the server can check if
730+
* it received the original operation with the same request ID. If it did, it
731+
* will ignore the second request.
736732
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
737733
* with the exception that zero UUID is not supported
738734
* (`00000000-0000-0000-0000-000000000000`).
@@ -757,13 +753,12 @@ public com.google.protobuf.ByteString getRequestIdBytes() {
757753
*
758754
*
759755
* <pre>
760-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
761-
* that if you must retry your request, the server will know to ignore the
762-
* request if it has already been completed.
763-
* For example, consider a situation where you make an initial request and
764-
* the request times out. If you make the request again with the same
765-
* request ID, the server can check if the original operation with the same
766-
* request ID was received, and if so, will ignore the second request.
756+
* Optional. You can specify an optional unique request ID, and if you need to retry
757+
* your request, the server will know to ignore the request if it's complete.
758+
* For example, you make an initial request and the request times out. If you
759+
* make the request again with the same request ID, the server can check if
760+
* it received the original operation with the same request ID. If it did, it
761+
* will ignore the second request.
767762
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
768763
* with the exception that zero UUID is not supported
769764
* (`00000000-0000-0000-0000-000000000000`).
@@ -787,13 +782,12 @@ public Builder setRequestId(java.lang.String value) {
787782
*
788783
*
789784
* <pre>
790-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
791-
* that if you must retry your request, the server will know to ignore the
792-
* request if it has already been completed.
793-
* For example, consider a situation where you make an initial request and
794-
* the request times out. If you make the request again with the same
795-
* request ID, the server can check if the original operation with the same
796-
* request ID was received, and if so, will ignore the second request.
785+
* Optional. You can specify an optional unique request ID, and if you need to retry
786+
* your request, the server will know to ignore the request if it's complete.
787+
* For example, you make an initial request and the request times out. If you
788+
* make the request again with the same request ID, the server can check if
789+
* it received the original operation with the same request ID. If it did, it
790+
* will ignore the second request.
797791
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
798792
* with the exception that zero UUID is not supported
799793
* (`00000000-0000-0000-0000-000000000000`).
@@ -813,13 +807,12 @@ public Builder clearRequestId() {
813807
*
814808
*
815809
* <pre>
816-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
817-
* that if you must retry your request, the server will know to ignore the
818-
* request if it has already been completed.
819-
* For example, consider a situation where you make an initial request and
820-
* the request times out. If you make the request again with the same
821-
* request ID, the server can check if the original operation with the same
822-
* request ID was received, and if so, will ignore the second request.
810+
* Optional. You can specify an optional unique request ID, and if you need to retry
811+
* your request, the server will know to ignore the request if it's complete.
812+
* For example, you make an initial request and the request times out. If you
813+
* make the request again with the same request ID, the server can check if
814+
* it received the original operation with the same request ID. If it did, it
815+
* will ignore the second request.
823816
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
824817
* with the exception that zero UUID is not supported
825818
* (`00000000-0000-0000-0000-000000000000`).

proto-google-cloud-channel-v1/src/main/java/com/google/cloud/channel/v1/ActivateEntitlementRequestOrBuilder.java

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public interface ActivateEntitlementRequestOrBuilder
2828
*
2929
* <pre>
3030
* Required. The resource name of the entitlement to activate.
31-
* The name takes the format:
31+
* Name uses the format:
3232
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
3333
* </pre>
3434
*
@@ -42,7 +42,7 @@ public interface ActivateEntitlementRequestOrBuilder
4242
*
4343
* <pre>
4444
* Required. The resource name of the entitlement to activate.
45-
* The name takes the format:
45+
* Name uses the format:
4646
* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
4747
* </pre>
4848
*
@@ -56,13 +56,12 @@ public interface ActivateEntitlementRequestOrBuilder
5656
*
5757
*
5858
* <pre>
59-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
60-
* that if you must retry your request, the server will know to ignore the
61-
* request if it has already been completed.
62-
* For example, consider a situation where you make an initial request and
63-
* the request times out. If you make the request again with the same
64-
* request ID, the server can check if the original operation with the same
65-
* request ID was received, and if so, will ignore the second request.
59+
* Optional. You can specify an optional unique request ID, and if you need to retry
60+
* your request, the server will know to ignore the request if it's complete.
61+
* For example, you make an initial request and the request times out. If you
62+
* make the request again with the same request ID, the server can check if
63+
* it received the original operation with the same request ID. If it did, it
64+
* will ignore the second request.
6665
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
6766
* with the exception that zero UUID is not supported
6867
* (`00000000-0000-0000-0000-000000000000`).
@@ -77,13 +76,12 @@ public interface ActivateEntitlementRequestOrBuilder
7776
*
7877
*
7978
* <pre>
80-
* Optional. An optional request ID to identify requests. Specify a unique request ID so
81-
* that if you must retry your request, the server will know to ignore the
82-
* request if it has already been completed.
83-
* For example, consider a situation where you make an initial request and
84-
* the request times out. If you make the request again with the same
85-
* request ID, the server can check if the original operation with the same
86-
* request ID was received, and if so, will ignore the second request.
79+
* Optional. You can specify an optional unique request ID, and if you need to retry
80+
* your request, the server will know to ignore the request if it's complete.
81+
* For example, you make an initial request and the request times out. If you
82+
* make the request again with the same request ID, the server can check if
83+
* it received the original operation with the same request ID. If it did, it
84+
* will ignore the second request.
8785
* The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
8886
* with the exception that zero UUID is not supported
8987
* (`00000000-0000-0000-0000-000000000000`).

0 commit comments

Comments
 (0)