Skip to content

api: Fix javadoc for ManagedChannelBuilder#forTarget(String) #6499

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.

Sign up for GitHub

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

Merged
ejona86 merged 2 commits into from
Dec 16, 2019
Merged

api: Fix javadoc for ManagedChannelBuilder#forTarget(String) #6499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b01bf25
api: Improve javadoc for ManagedChannelBuilder#forTarget(String)
ST-DDT Dec 8, 2019
697895f
Adjust javadoc
ST-DDT Dec 16, 2019
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
2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ The following code snippet shows how you can call the Google Cloud PubSub API us

```java
// Create a channel to the test service.
ManagedChannel channel = ManagedChannelBuilder.forTarget("pubsub.googleapis.com")
ManagedChannel channel = ManagedChannelBuilder.forTarget("dns:///pubsub.googleapis.com")
.build();
// Get the default credentials from the environment
GoogleCredentials creds = GoogleCredentials.getApplicationDefault();
Expand Down
7 changes: 5 additions & 2 deletions api/src/main/java/io/grpc/ManagedChannelBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,11 @@ public static ManagedChannelBuilder<?> forAddress(String name, int port) {
* </ul>
*
* <p>An authority string will be converted to a {@code NameResolver}-compliant URI, which has
* {@code "dns"} as the scheme, no authority, and the original authority string as its path after
* properly escaped. Example authority strings:
* the scheme from the name resolver with the highest priority (e.g. {@code "dns"}),
* no authority, and the original authority string as its path after properly escaped.
* We recommend libraries to specify the schema explicitly if it is known, since libraries cannot
* know which NameResolver will be default during runtime.
* Example authority strings:
* <ul>
* <li>{@code "localhost"}</li>
* <li>{@code "127.0.0.1"}</li>
Expand Down