Class SnapshotsSettings (1.6.0-beta) 

public class SnapshotsSettings extends 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 total timeout of get to 30 seconds:


 SnapshotsSettings.Builder snapshotsSettingsBuilder = SnapshotsSettings.newBuilder();
 snapshotsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         snapshotsSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SnapshotsSettings snapshotsSettings = snapshotsSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > SnapshotsSettings

Constructors

SnapshotsSettings(SnapshotsSettings.Builder settingsBuilder)

protected SnapshotsSettings(SnapshotsSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderSnapshotsSettings.Builder

Methods

create(SnapshotsStubSettings stub)

public static final SnapshotsSettings create(SnapshotsStubSettings stub)
Parameter
NameDescription
stubSnapshotsStubSettings
Returns
TypeDescription
SnapshotsSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteOperationSettings()

public OperationCallSettings<DeleteSnapshotRequest,Operation,Operation> deleteOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteSnapshotRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteSnapshotRequest,Operation> deleteSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteSnapshotRequest,Operation>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicySnapshotRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetIamPolicySnapshotRequest,Policy>

getSettings()

public UnaryCallSettings<GetSnapshotRequest,Snapshot> getSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetSnapshotRequest,Snapshot>

listSettings()

public PagedCallSettings<ListSnapshotsRequest,SnapshotList,SnapshotsClient.ListPagedResponse> listSettings()

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

Returns
TypeDescription
PagedCallSettings<ListSnapshotsRequest,SnapshotList,ListPagedResponse>

newBuilder()

public static SnapshotsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
SnapshotsSettings.Builder

newBuilder(ClientContext clientContext)

public static SnapshotsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
SnapshotsSettings.Builder

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicySnapshotRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<SetIamPolicySnapshotRequest,Policy>

setLabelsOperationSettings()

public OperationCallSettings<SetLabelsSnapshotRequest,Operation,Operation> setLabelsOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<SetLabelsSnapshotRequest,Operation,Operation>

setLabelsSettings()

public UnaryCallSettings<SetLabelsSnapshotRequest,Operation> setLabelsSettings()

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

Returns
TypeDescription
UnaryCallSettings<SetLabelsSnapshotRequest,Operation>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsSnapshotRequest,TestPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<TestIamPermissionsSnapshotRequest,TestPermissionsResponse>

toBuilder()

public SnapshotsSettings.Builder toBuilder()

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

Returns
TypeDescription
SnapshotsSettings.Builder
Overrides