Skip to content

Commit fe0dd61

Browse files
authored
fix(option): update WithEndpoint docs (#3032)
fixes: googleapis/google-cloud-go#11625
1 parent 1b9abf7 commit fe0dd61

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

option/option.go

+8-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,14 @@ func (w withCredentialsJSON) Apply(o *internal.DialSettings) {
9595
}
9696

9797
// WithEndpoint returns a ClientOption that overrides the default endpoint
98-
// to be used for a service.
98+
// to be used for a service. Please note that by default Google APIs only
99+
// accept HTTPS traffic.
100+
//
101+
// For a gRPC client, the port number is typically included in the endpoint.
102+
// Example: "us-central1-speech.googleapis.com:443".
103+
//
104+
// For a REST client, the port number is typically not included. Example:
105+
// "https://speech.googleapis.com".
99106
func WithEndpoint(url string) ClientOption {
100107
return withEndpoint(url)
101108
}

0 commit comments

Comments
 (0)