com.google.cloud.compute.v1

Class DiskSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<DiskSettings>

com.google.cloud.compute.v1.DiskSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class DiskSettings
extends ClientSettings<DiskSettings>

Settings class to configure an instance of DiskClient.

The default instance has everything set to sensible defaults:

• The default service address (https://www.googleapis.com/compute/v1/projects/) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object. For example, to set the total timeout of createSnapshotDisk to 30 seconds:

 
 DiskSettings.Builder diskSettingsBuilder =
     DiskSettings.newBuilder();
 diskSettingsBuilder.createSnapshotDiskSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 DiskSettings diskSettings = diskSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiskSettings.Builder Builder for DiskSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiskSettings(DiskSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
PagedCallSettings<AggregatedListDisksHttpRequest,DiskAggregatedList,DiskClient.AggregatedListDisksPagedResponse>	aggregatedListDisksSettings() Returns the object with the settings used for calls to aggregatedListDisks.
static DiskSettings	create(DiskStubSettings stub)
UnaryCallSettings<CreateSnapshotDiskHttpRequest,Operation>	createSnapshotDiskSettings() Returns the object with the settings used for calls to createSnapshotDisk.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteDiskHttpRequest,Operation>	deleteDiskSettings() Returns the object with the settings used for calls to deleteDisk.
static String	getDefaultEndpoint() Returns the default service endpoint.
static int	getDefaultServicePort() Returns the default service port.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetDiskHttpRequest,Disk>	getDiskSettings() Returns the object with the settings used for calls to getDisk.
UnaryCallSettings<GetIamPolicyDiskHttpRequest,Policy>	getIamPolicyDiskSettings() Returns the object with the settings used for calls to getIamPolicyDisk.
UnaryCallSettings<InsertDiskHttpRequest,Operation>	insertDiskSettings() Returns the object with the settings used for calls to insertDisk.
PagedCallSettings<ListDisksHttpRequest,DiskList,DiskClient.ListDisksPagedResponse>	listDisksSettings() Returns the object with the settings used for calls to listDisks.
static DiskSettings.Builder	newBuilder() Returns a new builder for this class.
static DiskSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<ResizeDiskHttpRequest,Operation>	resizeDiskSettings() Returns the object with the settings used for calls to resizeDisk.
UnaryCallSettings<SetIamPolicyDiskHttpRequest,Policy>	setIamPolicyDiskSettings() Returns the object with the settings used for calls to setIamPolicyDisk.
UnaryCallSettings<SetLabelsDiskHttpRequest,Operation>	setLabelsDiskSettings() Returns the object with the settings used for calls to setLabelsDisk.
UnaryCallSettings<TestIamPermissionsDiskHttpRequest,TestPermissionsResponse>	testIamPermissionsDiskSettings() Returns the object with the settings used for calls to testIamPermissionsDisk.
DiskSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DiskSettings

protected DiskSettings(DiskSettings.Builder settingsBuilder)
                throws IOException

Throws:

IOException

Method Detail

aggregatedListDisksSettings

public PagedCallSettings<AggregatedListDisksHttpRequest,DiskAggregatedList,DiskClient.AggregatedListDisksPagedResponse> aggregatedListDisksSettings()

Returns the object with the settings used for calls to aggregatedListDisks.

createSnapshotDiskSettings

public UnaryCallSettings<CreateSnapshotDiskHttpRequest,Operation> createSnapshotDiskSettings()

Returns the object with the settings used for calls to createSnapshotDisk.

deleteDiskSettings

public UnaryCallSettings<DeleteDiskHttpRequest,Operation> deleteDiskSettings()

Returns the object with the settings used for calls to deleteDisk.

getDiskSettings

public UnaryCallSettings<GetDiskHttpRequest,Disk> getDiskSettings()

Returns the object with the settings used for calls to getDisk.

getIamPolicyDiskSettings

public UnaryCallSettings<GetIamPolicyDiskHttpRequest,Policy> getIamPolicyDiskSettings()

Returns the object with the settings used for calls to getIamPolicyDisk.

insertDiskSettings

public UnaryCallSettings<InsertDiskHttpRequest,Operation> insertDiskSettings()

Returns the object with the settings used for calls to insertDisk.

listDisksSettings

public PagedCallSettings<ListDisksHttpRequest,DiskList,DiskClient.ListDisksPagedResponse> listDisksSettings()

Returns the object with the settings used for calls to listDisks.

resizeDiskSettings

public UnaryCallSettings<ResizeDiskHttpRequest,Operation> resizeDiskSettings()

Returns the object with the settings used for calls to resizeDisk.

setIamPolicyDiskSettings

public UnaryCallSettings<SetIamPolicyDiskHttpRequest,Policy> setIamPolicyDiskSettings()

Returns the object with the settings used for calls to setIamPolicyDisk.

setLabelsDiskSettings

public UnaryCallSettings<SetLabelsDiskHttpRequest,Operation> setLabelsDiskSettings()

Returns the object with the settings used for calls to setLabelsDisk.

testIamPermissionsDiskSettings

public UnaryCallSettings<TestIamPermissionsDiskHttpRequest,TestPermissionsResponse> testIamPermissionsDiskSettings()

Returns the object with the settings used for calls to testIamPermissionsDisk.

create

public static final DiskSettings create(DiskStubSettings stub)
                                 throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServicePort

public static int getDefaultServicePort()

Returns the default service port.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static DiskSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static DiskSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DiskSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class ClientSettings<DiskSettings>