Class ReservationsSettings (1.63.0)

public class ReservationsSettings extends ClientSettings<ReservationsSettings>

Settings class to configure an instance of ReservationsClient.

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 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
 ReservationsSettings.Builder reservationsSettingsBuilder = ReservationsSettings.newBuilder();
 reservationsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         reservationsSettingsBuilder
             .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());
 ReservationsSettings reservationsSettings = reservationsSettingsBuilder.build();

Please refer to the Client Side Retry Guide 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
 ReservationsSettings.Builder reservationsSettingsBuilder = ReservationsSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 reservationsSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > ReservationsSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ReservationsStubSettings stub)

public static final ReservationsSettings create(ReservationsStubSettings stub)

Parameter
Name	Description
`stub`	`ReservationsStubSettings`

Returns
Type	Description
`ReservationsSettings`

Exceptions
Type	Description
`IOException`

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

public static ReservationsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
`ReservationsSettings.Builder`

newBuilder(ClientContext clientContext)

public static ReservationsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`ReservationsSettings.Builder`

Constructors

ReservationsSettings(ReservationsSettings.Builder settingsBuilder)

protected ReservationsSettings(ReservationsSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`ReservationsSettings.Builder`

Methods

aggregatedListSettings()

public PagedCallSettings<AggregatedListReservationsRequest,ReservationAggregatedList,ReservationsClient.AggregatedListPagedResponse> aggregatedListSettings()

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

Returns
Type	Description
`PagedCallSettings<AggregatedListReservationsRequest,ReservationAggregatedList,AggregatedListPagedResponse>`

deleteOperationSettings()

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

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

Returns
Type	Description
`OperationCallSettings<DeleteReservationRequest,Operation,Operation>`

deleteSettings()

public UnaryCallSettings<DeleteReservationRequest,Operation> deleteSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteReservationRequest,Operation>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyReservationRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<GetIamPolicyReservationRequest,Policy>`

getSettings()

public UnaryCallSettings<GetReservationRequest,Reservation> getSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetReservationRequest,Reservation>`

insertOperationSettings()

public OperationCallSettings<InsertReservationRequest,Operation,Operation> insertOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<InsertReservationRequest,Operation,Operation>`

insertSettings()

public UnaryCallSettings<InsertReservationRequest,Operation> insertSettings()

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

Returns
Type	Description
`UnaryCallSettings<InsertReservationRequest,Operation>`

listSettings()

public PagedCallSettings<ListReservationsRequest,ReservationList,ReservationsClient.ListPagedResponse> listSettings()

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

Returns
Type	Description
`PagedCallSettings<ListReservationsRequest,ReservationList,ListPagedResponse>`

resizeOperationSettings()

public OperationCallSettings<ResizeReservationRequest,Operation,Operation> resizeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ResizeReservationRequest,Operation,Operation>`

resizeSettings()

public UnaryCallSettings<ResizeReservationRequest,Operation> resizeSettings()

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

Returns
Type	Description
`UnaryCallSettings<ResizeReservationRequest,Operation>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyReservationRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<SetIamPolicyReservationRequest,Policy>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsReservationRequest,TestPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<TestIamPermissionsReservationRequest,TestPermissionsResponse>`

toBuilder()

public ReservationsSettings.Builder toBuilder()

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

Returns
Type	Description
`ReservationsSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateOperationSettings()

public OperationCallSettings<UpdateReservationRequest,Operation,Operation> updateOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateReservationRequest,Operation,Operation>`

updateSettings()

public UnaryCallSettings<UpdateReservationRequest,Operation> updateSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateReservationRequest,Operation>`