Skip to content

Commit 8c353ec

Browse files
author
Ajay Kannan
committed
Add javadoc
1 parent c486452 commit 8c353ec

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

gcloud-java-core/src/main/java/com/google/gcloud/AuthCredentials.java

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,12 @@ public RestorableState<AuthCredentials> capture() {
132132
}
133133
}
134134

135+
/**
136+
* Represents service account credentials.
137+
*
138+
* @see <a href="https://cloud.google.com/docs/authentication#user_accounts_and_service_accounts">
139+
* User accounts and service accounts</a>
140+
*/
135141
public static class ServiceAccountAuthCredentials extends AuthCredentials {
136142

137143
private final String account;
@@ -195,6 +201,14 @@ public RestorableState<AuthCredentials> capture() {
195201
}
196202
}
197203

204+
/**
205+
* Represents Application Default Credentials, which are credentials that are inferred from the
206+
* runtime environment.
207+
*
208+
* @see <a
209+
* href="https://developers.google.com/identity/protocols/application-default-credentials">
210+
* Google Application Default Credentials</a>
211+
*/
198212
public static class ApplicationDefaultAuthCredentials extends AuthCredentials {
199213

200214
private GoogleCredentials googleCredentials;
@@ -243,6 +257,11 @@ public RestorableState<AuthCredentials> capture() {
243257
}
244258
}
245259

260+
/**
261+
* Represents that requests sent to the server should not be authenticated. This is typically
262+
* useful when using the local service emulators, such as {@code LocalGcdHelper} and
263+
* {@code LocalResourceManagerHelper}.
264+
*/
246265
public static class NoAuthCredentials extends AuthCredentials {
247266

248267
private static final AuthCredentials INSTANCE = new NoAuthCredentials();
@@ -309,7 +328,9 @@ public static ServiceAccountAuthCredentials createFor(String account, PrivateKey
309328
}
310329

311330
/**
312-
* Creates a placeholder denoting that no credentials should be used.
331+
* Creates a placeholder denoting that no credentials should be used. This is typically useful
332+
* when using the local service emulators, such as {@code LocalGcdHelper} and
333+
* {@code LocalResourceManagerHelper}.
313334
*/
314335
public static AuthCredentials noAuth() {
315336
return NoAuthCredentials.INSTANCE;

0 commit comments

Comments
 (0)