com.google.cloud

Class WaitForOption.CheckingPeriod

java.lang.Object

com.google.cloud.WaitForOption

com.google.cloud.WaitForOption.CheckingPeriod

All Implemented Interfaces:

Serializable

Enclosing class:

WaitForOption

public static final class WaitForOption.CheckingPeriod
extends WaitForOption

This class represents an option to set how frequently the resource status should be checked. Objects of this class keep the actual period and related time unit for the checking period.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.WaitForOption

WaitForOption.CheckingPeriod, WaitForOption.Timeout

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static WaitForOption.CheckingPeriod	getOrDefault(WaitForOption... options) Returns the CheckingPeriod option specified in options.
int	hashCode()
long	period() Returns the checking period.
void	sleep() Blocks the current thread for the amount of time specified by this object.
String	toString()
TimeUnit	unit() Returns the time unit for period().

Methods inherited from class com.google.cloud.WaitForOption

checkEvery, timeout

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

period

public long period()

Returns the checking period.

unit

public TimeUnit unit()

Returns the time unit for period().

sleep

public void sleep()
           throws InterruptedException

Blocks the current thread for the amount of time specified by this object.

Throws:

InterruptedException - if the current thread was interrupted

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getOrDefault

public static WaitForOption.CheckingPeriod getOrDefault(WaitForOption... options)

Returns the CheckingPeriod option specified in options. If no CheckingPeriod could be found among options, the default checking period (500 milliseconds) is used.