com.google.cloud.compute.v1

Class SnapshotsSettings

java.lang.Object

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

com.google.cloud.compute.v1.SnapshotsSettings

@Generated(value="by gapic-generator-java")
public class SnapshotsSettings
extends com.google.api.gax.rpc.ClientSettings<SnapshotsSettings>

Settings class to configure an instance of SnapshotsClient.

The default instance has everything set to sensible defaults:

• The default service address (compute.googleapis.com) 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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of get:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SnapshotsSettings.Builder snapshotsSettingsBuilder = SnapshotsSettings.newBuilder();
 snapshotsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         snapshotsSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 SnapshotsSettings snapshotsSettings = snapshotsSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for delete:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SnapshotsSettings.Builder snapshotsSettingsBuilder = SnapshotsSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 snapshotsSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SnapshotsSettings	create(SnapshotsStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteSnapshotRequest,Operation,Operation>	deleteOperationSettings() Returns the object with the settings used for calls to delete.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSnapshotRequest,Operation>	deleteSettings() Returns the object with the settings used for calls to delete.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetIamPolicySnapshotRequest,Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetSnapshotRequest,Snapshot>	getSettings() Returns the object with the settings used for calls to get.
com.google.api.gax.rpc.OperationCallSettings<InsertSnapshotRequest,Operation,Operation>	insertOperationSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.UnaryCallSettings<InsertSnapshotRequest,Operation>	insertSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.PagedCallSettings<ListSnapshotsRequest,SnapshotList,SnapshotsClient.ListPagedResponse>	listSettings() Returns the object with the settings used for calls to list.
static SnapshotsSettings.Builder	newBuilder() Returns a new builder for this class.
static SnapshotsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<SetIamPolicySnapshotRequest,Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.OperationCallSettings<SetLabelsSnapshotRequest,Operation,Operation>	setLabelsOperationSettings() Returns the object with the settings used for calls to setLabels.
com.google.api.gax.rpc.UnaryCallSettings<SetLabelsSnapshotRequest,Operation>	setLabelsSettings() Returns the object with the settings used for calls to setLabels.
com.google.api.gax.rpc.UnaryCallSettings<TestIamPermissionsSnapshotRequest,TestPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
SnapshotsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotsSettings

protected SnapshotsSettings(SnapshotsSettings.Builder settingsBuilder)
                     throws IOException

Throws:

IOException

Method Detail

deleteSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSnapshotRequest,Operation> deleteSettings()

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

deleteOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteSnapshotRequest,Operation,Operation> deleteOperationSettings()

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

getSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSnapshotRequest,Snapshot> getSettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetIamPolicySnapshotRequest,Policy> getIamPolicySettings()

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

insertSettings

public com.google.api.gax.rpc.UnaryCallSettings<InsertSnapshotRequest,Operation> insertSettings()

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

insertOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<InsertSnapshotRequest,Operation,Operation> insertOperationSettings()

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

listSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSnapshotsRequest,SnapshotList,SnapshotsClient.ListPagedResponse> listSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<SetIamPolicySnapshotRequest,Policy> setIamPolicySettings()

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

setLabelsSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetLabelsSnapshotRequest,Operation> setLabelsSettings()

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

setLabelsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetLabelsSnapshotRequest,Operation,Operation> setLabelsOperationSettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<TestIamPermissionsSnapshotRequest,TestPermissionsResponse> testIamPermissionsSettings()

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

create

public static final SnapshotsSettings create(SnapshotsStubSettings stub)
                                      throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static SnapshotsSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static SnapshotsSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public SnapshotsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<SnapshotsSettings>