Class GDCHardwareManagementStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<GDCHardwareManagementStubSettings>
com.google.cloud.gdchardwaremanagement.v1alpha.stub.GDCHardwareManagementStubSettings
@BetaApi
@Generated("by gapic-generator-java")
public class GDCHardwareManagementStubSettings
extends StubSettings<GDCHardwareManagementStubSettings>
Settings class to configure an instance of
GDCHardwareManagementStub.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
GDCHardwareManagementStubSettings.Builder gDCHardwareManagementSettingsBuilder =
GDCHardwareManagementStubSettings.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());
GDCHardwareManagementStubSettings gDCHardwareManagementSettings =
gDCHardwareManagementSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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
GDCHardwareManagementStubSettings.Builder gDCHardwareManagementSettingsBuilder =
GDCHardwareManagementStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
gDCHardwareManagementSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for GDCHardwareManagementStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to cancelOrder.Returns the object with the settings used for calls to cancelOrder.Returns the object with the settings used for calls to createComment.Returns the object with the settings used for calls to createComment.Returns the object with the settings used for calls to createHardwareGroup.Returns the object with the settings used for calls to createHardwareGroup.Returns the object with the settings used for calls to createHardware.Returns the object with the settings used for calls to createHardware.Returns the object with the settings used for calls to createOrder.Returns the object with the settings used for calls to createOrder.Returns the object with the settings used for calls to createSite.Returns the object with the settings used for calls to createSite.Returns the object with the settings used for calls to createZone.Returns the object with the settings used for calls to createZone.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteHardwareGroupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteHardwareGroup.Returns the object with the settings used for calls to deleteHardwareGroup.OperationCallSettings<DeleteHardwareRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteHardware.Returns the object with the settings used for calls to deleteHardware.OperationCallSettings<DeleteOrderRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteOrder.Returns the object with the settings used for calls to deleteOrder.OperationCallSettings<DeleteSiteRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteSite.Returns the object with the settings used for calls to deleteSite.OperationCallSettings<DeleteZoneRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteZone.Returns the object with the settings used for calls to deleteZone.Returns the object with the settings used for calls to getChangeLogEntry.Returns the object with the settings used for calls to getComment.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getHardwareGroup.Returns the object with the settings used for calls to getHardware.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getOrder.Returns the default service name.Returns the object with the settings used for calls to getSite.Returns the object with the settings used for calls to getSku.Returns the object with the settings used for calls to getZone.PagedCallSettings<ListChangeLogEntriesRequest,ListChangeLogEntriesResponse, GDCHardwareManagementClient.ListChangeLogEntriesPagedResponse> Returns the object with the settings used for calls to listChangeLogEntries.PagedCallSettings<ListCommentsRequest,ListCommentsResponse, GDCHardwareManagementClient.ListCommentsPagedResponse> Returns the object with the settings used for calls to listComments.PagedCallSettings<ListHardwareGroupsRequest,ListHardwareGroupsResponse, GDCHardwareManagementClient.ListHardwareGroupsPagedResponse> Returns the object with the settings used for calls to listHardwareGroups.PagedCallSettings<ListHardwareRequest,ListHardwareResponse, GDCHardwareManagementClient.ListHardwarePagedResponse> Returns the object with the settings used for calls to listHardware.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, GDCHardwareManagementClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListOrdersRequest,ListOrdersResponse, GDCHardwareManagementClient.ListOrdersPagedResponse> Returns the object with the settings used for calls to listOrders.PagedCallSettings<ListSitesRequest,ListSitesResponse, GDCHardwareManagementClient.ListSitesPagedResponse> Returns the object with the settings used for calls to listSites.PagedCallSettings<ListSkusRequest,ListSkusResponse, GDCHardwareManagementClient.ListSkusPagedResponse> Returns the object with the settings used for calls to listSkus.PagedCallSettings<ListZonesRequest,ListZonesResponse, GDCHardwareManagementClient.ListZonesPagedResponse> Returns the object with the settings used for calls to listZones.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to recordActionOnComment.Returns the object with the settings used for calls to requestOrderDateChange.Returns the object with the settings used for calls to requestOrderDateChange.Returns the object with the settings used for calls to signalZoneState.Returns the object with the settings used for calls to signalZoneState.Returns the object with the settings used for calls to submitOrder.Returns the object with the settings used for calls to submitOrder.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateHardwareGroup.Returns the object with the settings used for calls to updateHardwareGroup.Returns the object with the settings used for calls to updateHardware.Returns the object with the settings used for calls to updateHardware.Returns the object with the settings used for calls to updateOrder.Returns the object with the settings used for calls to updateOrder.Returns the object with the settings used for calls to updateSite.Returns the object with the settings used for calls to updateSite.Returns the object with the settings used for calls to updateZone.Returns the object with the settings used for calls to updateZone.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
GDCHardwareManagementStubSettings
protected GDCHardwareManagementStubSettings(GDCHardwareManagementStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listOrdersSettings
public PagedCallSettings<ListOrdersRequest,ListOrdersResponse, listOrdersSettings()GDCHardwareManagementClient.ListOrdersPagedResponse> Returns the object with the settings used for calls to listOrders. -
getOrderSettings
Returns the object with the settings used for calls to getOrder. -
createOrderSettings
Returns the object with the settings used for calls to createOrder. -
createOrderOperationSettings
public OperationCallSettings<CreateOrderRequest,Order, createOrderOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createOrder. -
updateOrderSettings
Returns the object with the settings used for calls to updateOrder. -
updateOrderOperationSettings
public OperationCallSettings<UpdateOrderRequest,Order, updateOrderOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateOrder. -
deleteOrderSettings
Returns the object with the settings used for calls to deleteOrder. -
deleteOrderOperationSettings
public OperationCallSettings<DeleteOrderRequest,com.google.protobuf.Empty, deleteOrderOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteOrder. -
submitOrderSettings
Returns the object with the settings used for calls to submitOrder. -
submitOrderOperationSettings
public OperationCallSettings<SubmitOrderRequest,Order, submitOrderOperationSettings()OperationMetadata> Returns the object with the settings used for calls to submitOrder. -
cancelOrderSettings
Returns the object with the settings used for calls to cancelOrder. -
cancelOrderOperationSettings
public OperationCallSettings<CancelOrderRequest,Order, cancelOrderOperationSettings()OperationMetadata> Returns the object with the settings used for calls to cancelOrder. -
listSitesSettings
public PagedCallSettings<ListSitesRequest,ListSitesResponse, listSitesSettings()GDCHardwareManagementClient.ListSitesPagedResponse> Returns the object with the settings used for calls to listSites. -
getSiteSettings
Returns the object with the settings used for calls to getSite. -
createSiteSettings
Returns the object with the settings used for calls to createSite. -
createSiteOperationSettings
public OperationCallSettings<CreateSiteRequest,Site, createSiteOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createSite. -
updateSiteSettings
Returns the object with the settings used for calls to updateSite. -
updateSiteOperationSettings
public OperationCallSettings<UpdateSiteRequest,Site, updateSiteOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateSite. -
deleteSiteSettings
Returns the object with the settings used for calls to deleteSite. -
deleteSiteOperationSettings
public OperationCallSettings<DeleteSiteRequest,com.google.protobuf.Empty, deleteSiteOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteSite. -
listHardwareGroupsSettings
public PagedCallSettings<ListHardwareGroupsRequest,ListHardwareGroupsResponse, listHardwareGroupsSettings()GDCHardwareManagementClient.ListHardwareGroupsPagedResponse> Returns the object with the settings used for calls to listHardwareGroups. -
getHardwareGroupSettings
Returns the object with the settings used for calls to getHardwareGroup. -
createHardwareGroupSettings
Returns the object with the settings used for calls to createHardwareGroup. -
createHardwareGroupOperationSettings
public OperationCallSettings<CreateHardwareGroupRequest,HardwareGroup, createHardwareGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createHardwareGroup. -
updateHardwareGroupSettings
Returns the object with the settings used for calls to updateHardwareGroup. -
updateHardwareGroupOperationSettings
public OperationCallSettings<UpdateHardwareGroupRequest,HardwareGroup, updateHardwareGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateHardwareGroup. -
deleteHardwareGroupSettings
Returns the object with the settings used for calls to deleteHardwareGroup. -
deleteHardwareGroupOperationSettings
public OperationCallSettings<DeleteHardwareGroupRequest,com.google.protobuf.Empty, deleteHardwareGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteHardwareGroup. -
listHardwareSettings
public PagedCallSettings<ListHardwareRequest,ListHardwareResponse, listHardwareSettings()GDCHardwareManagementClient.ListHardwarePagedResponse> Returns the object with the settings used for calls to listHardware. -
getHardwareSettings
Returns the object with the settings used for calls to getHardware. -
createHardwareSettings
Returns the object with the settings used for calls to createHardware. -
createHardwareOperationSettings
public OperationCallSettings<CreateHardwareRequest,Hardware, createHardwareOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createHardware. -
updateHardwareSettings
Returns the object with the settings used for calls to updateHardware. -
updateHardwareOperationSettings
public OperationCallSettings<UpdateHardwareRequest,Hardware, updateHardwareOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateHardware. -
deleteHardwareSettings
Returns the object with the settings used for calls to deleteHardware. -
deleteHardwareOperationSettings
public OperationCallSettings<DeleteHardwareRequest,com.google.protobuf.Empty, deleteHardwareOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteHardware. -
listCommentsSettings
public PagedCallSettings<ListCommentsRequest,ListCommentsResponse, listCommentsSettings()GDCHardwareManagementClient.ListCommentsPagedResponse> Returns the object with the settings used for calls to listComments. -
getCommentSettings
Returns the object with the settings used for calls to getComment. -
createCommentSettings
Returns the object with the settings used for calls to createComment. -
createCommentOperationSettings
public OperationCallSettings<CreateCommentRequest,Comment, createCommentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createComment. -
recordActionOnCommentSettings
Returns the object with the settings used for calls to recordActionOnComment. -
listChangeLogEntriesSettings
public PagedCallSettings<ListChangeLogEntriesRequest,ListChangeLogEntriesResponse, listChangeLogEntriesSettings()GDCHardwareManagementClient.ListChangeLogEntriesPagedResponse> Returns the object with the settings used for calls to listChangeLogEntries. -
getChangeLogEntrySettings
Returns the object with the settings used for calls to getChangeLogEntry. -
listSkusSettings
public PagedCallSettings<ListSkusRequest,ListSkusResponse, listSkusSettings()GDCHardwareManagementClient.ListSkusPagedResponse> Returns the object with the settings used for calls to listSkus. -
getSkuSettings
Returns the object with the settings used for calls to getSku. -
listZonesSettings
public PagedCallSettings<ListZonesRequest,ListZonesResponse, listZonesSettings()GDCHardwareManagementClient.ListZonesPagedResponse> Returns the object with the settings used for calls to listZones. -
getZoneSettings
Returns the object with the settings used for calls to getZone. -
createZoneSettings
Returns the object with the settings used for calls to createZone. -
createZoneOperationSettings
public OperationCallSettings<CreateZoneRequest,Zone, createZoneOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createZone. -
updateZoneSettings
Returns the object with the settings used for calls to updateZone. -
updateZoneOperationSettings
public OperationCallSettings<UpdateZoneRequest,Zone, updateZoneOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateZone. -
deleteZoneSettings
Returns the object with the settings used for calls to deleteZone. -
deleteZoneOperationSettings
public OperationCallSettings<DeleteZoneRequest,com.google.protobuf.Empty, deleteZoneOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteZone. -
signalZoneStateSettings
Returns the object with the settings used for calls to signalZoneState. -
signalZoneStateOperationSettings
public OperationCallSettings<SignalZoneStateRequest,Zone, signalZoneStateOperationSettings()OperationMetadata> Returns the object with the settings used for calls to signalZoneState. -
requestOrderDateChangeSettings
Returns the object with the settings used for calls to requestOrderDateChange. -
requestOrderDateChangeOperationSettings
public OperationCallSettings<RequestOrderDateChangeRequest,Order, requestOrderDateChangeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to requestOrderDateChange. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()GDCHardwareManagementClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<GDCHardwareManagementStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<GDCHardwareManagementStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<GDCHardwareManagementStubSettings>
-