Skip to content

Commit 6423879

Browse files
committed
Add timeout getters and javadocs to StorageOptions
1 parent 51bfef6 commit 6423879

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,30 +338,52 @@ protected static String getAppEngineProjectId() {
338338

339339
protected abstract Set<String> scopes();
340340

341+
/**
342+
* Returns the project id.
343+
*/
341344
public String projectId() {
342345
return projectId;
343346
}
344347

348+
/**
349+
* Returns the service host.
350+
*/
345351
public String host() {
346352
return host;
347353
}
348354

355+
/**
356+
* Returns the transport factory.
357+
*/
349358
public HttpTransportFactory httpTransportFactory() {
350359
return httpTransportFactory;
351360
}
352361

362+
/**
363+
* Returns the authentication credentials.
364+
*/
353365
public AuthCredentials authCredentials() {
354366
return authCredentials;
355367
}
356368

369+
/**
370+
* Returns configuration parameters for request retries.
371+
*/
357372
public RetryParams retryParams() {
358373
return retryParams != null ? retryParams : RetryParams.noRetries();
359374
}
360375

376+
/**
377+
* Returns the factory for rpc services.
378+
*/
361379
public ServiceRpcFactory<ServiceRpcT, OptionsT> serviceRpcFactory() {
362380
return serviceRpcFactory;
363381
}
364382

383+
/**
384+
* Returns a request initializer responsible for initializing requests according to service
385+
* options.
386+
*/
365387
public HttpRequestInitializer httpRequestInitializer() {
366388
HttpTransport httpTransport = httpTransportFactory.create();
367389
final HttpRequestInitializer baseRequestInitializer =
@@ -380,6 +402,22 @@ public void initialize(HttpRequest httpRequest) throws IOException {
380402
};
381403
}
382404

405+
/**
406+
* Returns the timeout in milliseconds to establish a connection. 0 is an infinite timeout, a
407+
* negative number is the default value (20000).
408+
*/
409+
public int connectTimeout() {
410+
return connectTimeout;
411+
}
412+
413+
/**
414+
* Returns the timeout in milliseconds to read from an established connection. 0 is an infinite
415+
* timeout, a negative number is the default value (20000).
416+
*/
417+
public int readTimeout() {
418+
return readTimeout;
419+
}
420+
383421
protected int baseHashCode() {
384422
return Objects.hash(projectId, host, httpTransportFactory, authCredentials, retryParams,
385423
serviceRpcFactory);

0 commit comments

Comments
 (0)