Skip to content

Commit 90a32af

Browse files
committed
improve javadoc for setter.
1 parent 591ef68 commit 90a32af

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,11 @@ public final class InstantiatingGrpcChannelProvider implements TransportChannelP
141141
*/
142142
@InternalApi
143143
public enum HardBoundTokenTypes {
144-
// Use ALTS bound tokens when using DirectPath
144+
// If DirectPath is used to create the channel, use hard ALTS-bound tokens for requests sent on
145+
// that channel.
145146
ALTS,
146-
// Use MTLS bound tokens when using S2A
147+
// If MTLS via S2A is used to create the channel, use hard MTLS-bound tokens for requests sent
148+
// on that channel.
147149
MTLS_S2A
148150
}
149151

@@ -721,20 +723,9 @@ public Builder setEndpoint(String endpoint) {
721723
/*
722724
* Sets the allowed hard bound token types for this TransportChannelProvider.
723725
*
724-
* <p>This is optional; if it is not provided, bearer tokens will be used.
725-
*
726-
* <p>Examples:
727-
*
728-
* <p>allowedValues is {HardBoundTokenTypes.ALTS}: If DirectPath is used to create the channel,
729-
* use hard ALTS-bound tokens for requests sent on that channel.
730-
*
731-
* <p>allowedValues is {HardBoundTokenTypes.MTLS_S2A}: If MTLS via S2A is used to create the
732-
* channel, use hard MTLS-bound tokens for requests sent on that channel.
733-
*
734-
* <p>allowedValues is {HardBoundTokenTypes.ALTS, HardBoundTokenTypes.MTLS_S2A}: if DirectPath
735-
* is used to create the channel, use hard ALTS-bound tokens for requests sent on that channel.
736-
* If MTLS via S2A is used to create the channel, use hard MTLS-bound tokens for requests sent
737-
* on that channel.
726+
* <p>The list of
727+
* {@link HardBoundTokenTypes} indicates for which methods of connecting to Google APIs hard bound tokens should
728+
* be used. This is optional; if it is not provided, bearer tokens will be used.
738729
*/
739730
@InternalApi
740731
public Builder setAllowHardBoundTokenTypes(List<HardBoundTokenTypes> allowedValues) {

0 commit comments

Comments
 (0)