public class GDCHardwareManagementSettings extends ClientSettings<GDCHardwareManagementSettings>Settings class to configure an instance of GDCHardwareManagementClient.
The default instance has everything set to sensible defaults:
- The default service address (gdchardwaremanagement.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 getOrder:
// 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
GDCHardwareManagementSettings.Builder gDCHardwareManagementSettingsBuilder =
GDCHardwareManagementSettings.newBuilder();
gDCHardwareManagementSettingsBuilder
.getOrderSettings()
.setRetrySettings(
gDCHardwareManagementSettingsBuilder
.getOrderSettings()
.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());
GDCHardwareManagementSettings gDCHardwareManagementSettings =
gDCHardwareManagementSettingsBuilder.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 createOrder:
// 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
GDCHardwareManagementSettings.Builder gDCHardwareManagementSettingsBuilder =
GDCHardwareManagementSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
gDCHardwareManagementSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(GDCHardwareManagementStubSettings stub)
public static final GDCHardwareManagementSettings create(GDCHardwareManagementStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
GDCHardwareManagementStubSettings |
| Returns | |
|---|---|
| Type | Description |
GDCHardwareManagementSettings |
|
| 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 |
|
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST 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 GDCHardwareManagementSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
GDCHardwareManagementSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static GDCHardwareManagementSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
GDCHardwareManagementSettings.Builder |
|
newHttpJsonBuilder()
public static GDCHardwareManagementSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
GDCHardwareManagementSettings.Builder |
|
Constructors
GDCHardwareManagementSettings(GDCHardwareManagementSettings.Builder settingsBuilder)
protected GDCHardwareManagementSettings(GDCHardwareManagementSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
GDCHardwareManagementSettings.Builder |
Methods
createCommentOperationSettings()
public OperationCallSettings<CreateCommentRequest,Comment,OperationMetadata> createCommentOperationSettings()Returns the object with the settings used for calls to createComment.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateCommentRequest,Comment,OperationMetadata> |
|
createCommentSettings()
public UnaryCallSettings<CreateCommentRequest,Operation> createCommentSettings()Returns the object with the settings used for calls to createComment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateCommentRequest,Operation> |
|
createHardwareGroupOperationSettings()
public OperationCallSettings<CreateHardwareGroupRequest,HardwareGroup,OperationMetadata> createHardwareGroupOperationSettings()Returns the object with the settings used for calls to createHardwareGroup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateHardwareGroupRequest,HardwareGroup,OperationMetadata> |
|
createHardwareGroupSettings()
public UnaryCallSettings<CreateHardwareGroupRequest,Operation> createHardwareGroupSettings()Returns the object with the settings used for calls to createHardwareGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateHardwareGroupRequest,Operation> |
|
createHardwareOperationSettings()
public OperationCallSettings<CreateHardwareRequest,Hardware,OperationMetadata> createHardwareOperationSettings()Returns the object with the settings used for calls to createHardware.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateHardwareRequest,Hardware,OperationMetadata> |
|
createHardwareSettings()
public UnaryCallSettings<CreateHardwareRequest,Operation> createHardwareSettings()Returns the object with the settings used for calls to createHardware.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateHardwareRequest,Operation> |
|
createOrderOperationSettings()
public OperationCallSettings<CreateOrderRequest,Order,OperationMetadata> createOrderOperationSettings()Returns the object with the settings used for calls to createOrder.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateOrderRequest,Order,OperationMetadata> |
|
createOrderSettings()
public UnaryCallSettings<CreateOrderRequest,Operation> createOrderSettings()Returns the object with the settings used for calls to createOrder.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateOrderRequest,Operation> |
|
createSiteOperationSettings()
public OperationCallSettings<CreateSiteRequest,Site,OperationMetadata> createSiteOperationSettings()Returns the object with the settings used for calls to createSite.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSiteRequest,Site,OperationMetadata> |
|
createSiteSettings()
public UnaryCallSettings<CreateSiteRequest,Operation> createSiteSettings()Returns the object with the settings used for calls to createSite.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSiteRequest,Operation> |
|
createZoneOperationSettings()
public OperationCallSettings<CreateZoneRequest,Zone,OperationMetadata> createZoneOperationSettings()Returns the object with the settings used for calls to createZone.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateZoneRequest,Zone,OperationMetadata> |
|
createZoneSettings()
public UnaryCallSettings<CreateZoneRequest,Operation> createZoneSettings()Returns the object with the settings used for calls to createZone.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateZoneRequest,Operation> |
|
deleteHardwareGroupOperationSettings()
public OperationCallSettings<DeleteHardwareGroupRequest,Empty,OperationMetadata> deleteHardwareGroupOperationSettings()Returns the object with the settings used for calls to deleteHardwareGroup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteHardwareGroupRequest,Empty,OperationMetadata> |
|
deleteHardwareGroupSettings()
public UnaryCallSettings<DeleteHardwareGroupRequest,Operation> deleteHardwareGroupSettings()Returns the object with the settings used for calls to deleteHardwareGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteHardwareGroupRequest,Operation> |
|
deleteHardwareOperationSettings()
public OperationCallSettings<DeleteHardwareRequest,Empty,OperationMetadata> deleteHardwareOperationSettings()Returns the object with the settings used for calls to deleteHardware.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteHardwareRequest,Empty,OperationMetadata> |
|
deleteHardwareSettings()
public UnaryCallSettings<DeleteHardwareRequest,Operation> deleteHardwareSettings()Returns the object with the settings used for calls to deleteHardware.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteHardwareRequest,Operation> |
|
deleteOrderOperationSettings()
public OperationCallSettings<DeleteOrderRequest,Empty,OperationMetadata> deleteOrderOperationSettings()Returns the object with the settings used for calls to deleteOrder.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteOrderRequest,Empty,OperationMetadata> |
|
deleteOrderSettings()
public UnaryCallSettings<DeleteOrderRequest,Operation> deleteOrderSettings()Returns the object with the settings used for calls to deleteOrder.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteOrderRequest,Operation> |
|
deleteSiteOperationSettings()
public OperationCallSettings<DeleteSiteRequest,Empty,OperationMetadata> deleteSiteOperationSettings()Returns the object with the settings used for calls to deleteSite.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteSiteRequest,Empty,OperationMetadata> |
|
deleteSiteSettings()
public UnaryCallSettings<DeleteSiteRequest,Operation> deleteSiteSettings()Returns the object with the settings used for calls to deleteSite.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSiteRequest,Operation> |
|
deleteZoneOperationSettings()
public OperationCallSettings<DeleteZoneRequest,Empty,OperationMetadata> deleteZoneOperationSettings()Returns the object with the settings used for calls to deleteZone.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteZoneRequest,Empty,OperationMetadata> |
|
deleteZoneSettings()
public UnaryCallSettings<DeleteZoneRequest,Operation> deleteZoneSettings()Returns the object with the settings used for calls to deleteZone.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteZoneRequest,Operation> |
|
getChangeLogEntrySettings()
public UnaryCallSettings<GetChangeLogEntryRequest,ChangeLogEntry> getChangeLogEntrySettings()Returns the object with the settings used for calls to getChangeLogEntry.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetChangeLogEntryRequest,ChangeLogEntry> |
|
getCommentSettings()
public UnaryCallSettings<GetCommentRequest,Comment> getCommentSettings()Returns the object with the settings used for calls to getComment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetCommentRequest,Comment> |
|
getHardwareGroupSettings()
public UnaryCallSettings<GetHardwareGroupRequest,HardwareGroup> getHardwareGroupSettings()Returns the object with the settings used for calls to getHardwareGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetHardwareGroupRequest,HardwareGroup> |
|
getHardwareSettings()
public UnaryCallSettings<GetHardwareRequest,Hardware> getHardwareSettings()Returns the object with the settings used for calls to getHardware.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetHardwareRequest,Hardware> |
|
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()Returns the object with the settings used for calls to getLocation.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getOrderSettings()
public UnaryCallSettings<GetOrderRequest,Order> getOrderSettings()Returns the object with the settings used for calls to getOrder.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetOrderRequest,Order> |
|
getSiteSettings()
public UnaryCallSettings<GetSiteRequest,Site> getSiteSettings()Returns the object with the settings used for calls to getSite.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSiteRequest,Site> |
|
getSkuSettings()
public UnaryCallSettings<GetSkuRequest,Sku> getSkuSettings()Returns the object with the settings used for calls to getSku.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSkuRequest,Sku> |
|
getZoneSettings()
public UnaryCallSettings<GetZoneRequest,Zone> getZoneSettings()Returns the object with the settings used for calls to getZone.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetZoneRequest,Zone> |
|
listChangeLogEntriesSettings()
public PagedCallSettings<ListChangeLogEntriesRequest,ListChangeLogEntriesResponse,GDCHardwareManagementClient.ListChangeLogEntriesPagedResponse> listChangeLogEntriesSettings()Returns the object with the settings used for calls to listChangeLogEntries.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListChangeLogEntriesRequest,ListChangeLogEntriesResponse,ListChangeLogEntriesPagedResponse> |
|
listCommentsSettings()
public PagedCallSettings<ListCommentsRequest,ListCommentsResponse,GDCHardwareManagementClient.ListCommentsPagedResponse> listCommentsSettings()Returns the object with the settings used for calls to listComments.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListCommentsRequest,ListCommentsResponse,ListCommentsPagedResponse> |
|
listHardwareGroupsSettings()
public PagedCallSettings<ListHardwareGroupsRequest,ListHardwareGroupsResponse,GDCHardwareManagementClient.ListHardwareGroupsPagedResponse> listHardwareGroupsSettings()Returns the object with the settings used for calls to listHardwareGroups.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListHardwareGroupsRequest,ListHardwareGroupsResponse,ListHardwareGroupsPagedResponse> |
|
listHardwareSettings()
public PagedCallSettings<ListHardwareRequest,ListHardwareResponse,GDCHardwareManagementClient.ListHardwarePagedResponse> listHardwareSettings()Returns the object with the settings used for calls to listHardware.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListHardwareRequest,ListHardwareResponse,ListHardwarePagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,GDCHardwareManagementClient.ListLocationsPagedResponse> listLocationsSettings()Returns the object with the settings used for calls to listLocations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
|
listOrdersSettings()
public PagedCallSettings<ListOrdersRequest,ListOrdersResponse,GDCHardwareManagementClient.ListOrdersPagedResponse> listOrdersSettings()Returns the object with the settings used for calls to listOrders.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListOrdersRequest,ListOrdersResponse,ListOrdersPagedResponse> |
|
listSitesSettings()
public PagedCallSettings<ListSitesRequest,ListSitesResponse,GDCHardwareManagementClient.ListSitesPagedResponse> listSitesSettings()Returns the object with the settings used for calls to listSites.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSitesRequest,ListSitesResponse,ListSitesPagedResponse> |
|
listSkusSettings()
public PagedCallSettings<ListSkusRequest,ListSkusResponse,GDCHardwareManagementClient.ListSkusPagedResponse> listSkusSettings()Returns the object with the settings used for calls to listSkus.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSkusRequest,ListSkusResponse,ListSkusPagedResponse> |
|
listZonesSettings()
public PagedCallSettings<ListZonesRequest,ListZonesResponse,GDCHardwareManagementClient.ListZonesPagedResponse> listZonesSettings()Returns the object with the settings used for calls to listZones.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListZonesRequest,ListZonesResponse,ListZonesPagedResponse> |
|
recordActionOnCommentSettings()
public UnaryCallSettings<RecordActionOnCommentRequest,Comment> recordActionOnCommentSettings()Returns the object with the settings used for calls to recordActionOnComment.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RecordActionOnCommentRequest,Comment> |
|
signalZoneStateOperationSettings()
public OperationCallSettings<SignalZoneStateRequest,Zone,OperationMetadata> signalZoneStateOperationSettings()Returns the object with the settings used for calls to signalZoneState.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<SignalZoneStateRequest,Zone,OperationMetadata> |
|
signalZoneStateSettings()
public UnaryCallSettings<SignalZoneStateRequest,Operation> signalZoneStateSettings()Returns the object with the settings used for calls to signalZoneState.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<SignalZoneStateRequest,Operation> |
|
submitOrderOperationSettings()
public OperationCallSettings<SubmitOrderRequest,Order,OperationMetadata> submitOrderOperationSettings()Returns the object with the settings used for calls to submitOrder.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<SubmitOrderRequest,Order,OperationMetadata> |
|
submitOrderSettings()
public UnaryCallSettings<SubmitOrderRequest,Operation> submitOrderSettings()Returns the object with the settings used for calls to submitOrder.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<SubmitOrderRequest,Operation> |
|
toBuilder()
public GDCHardwareManagementSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
GDCHardwareManagementSettings.Builder |
|
updateHardwareGroupOperationSettings()
public OperationCallSettings<UpdateHardwareGroupRequest,HardwareGroup,OperationMetadata> updateHardwareGroupOperationSettings()Returns the object with the settings used for calls to updateHardwareGroup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateHardwareGroupRequest,HardwareGroup,OperationMetadata> |
|
updateHardwareGroupSettings()
public UnaryCallSettings<UpdateHardwareGroupRequest,Operation> updateHardwareGroupSettings()Returns the object with the settings used for calls to updateHardwareGroup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateHardwareGroupRequest,Operation> |
|
updateHardwareOperationSettings()
public OperationCallSettings<UpdateHardwareRequest,Hardware,OperationMetadata> updateHardwareOperationSettings()Returns the object with the settings used for calls to updateHardware.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateHardwareRequest,Hardware,OperationMetadata> |
|
updateHardwareSettings()
public UnaryCallSettings<UpdateHardwareRequest,Operation> updateHardwareSettings()Returns the object with the settings used for calls to updateHardware.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateHardwareRequest,Operation> |
|
updateOrderOperationSettings()
public OperationCallSettings<UpdateOrderRequest,Order,OperationMetadata> updateOrderOperationSettings()Returns the object with the settings used for calls to updateOrder.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateOrderRequest,Order,OperationMetadata> |
|
updateOrderSettings()
public UnaryCallSettings<UpdateOrderRequest,Operation> updateOrderSettings()Returns the object with the settings used for calls to updateOrder.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateOrderRequest,Operation> |
|
updateSiteOperationSettings()
public OperationCallSettings<UpdateSiteRequest,Site,OperationMetadata> updateSiteOperationSettings()Returns the object with the settings used for calls to updateSite.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateSiteRequest,Site,OperationMetadata> |
|
updateSiteSettings()
public UnaryCallSettings<UpdateSiteRequest,Operation> updateSiteSettings()Returns the object with the settings used for calls to updateSite.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSiteRequest,Operation> |
|
updateZoneOperationSettings()
public OperationCallSettings<UpdateZoneRequest,Zone,OperationMetadata> updateZoneOperationSettings()Returns the object with the settings used for calls to updateZone.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateZoneRequest,Zone,OperationMetadata> |
|
updateZoneSettings()
public UnaryCallSettings<UpdateZoneRequest,Operation> updateZoneSettings()Returns the object with the settings used for calls to updateZone.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateZoneRequest,Operation> |
|