Class OrderServiceStubSettings (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public class OrderServiceStubSettings extends StubSettings<OrderServiceStubSettings>

Settings class to configure an instance of OrderServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (admanager.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
 OrderServiceStubSettings.Builder orderServiceSettingsBuilder =
     OrderServiceStubSettings.newBuilder();
 orderServiceSettingsBuilder
     .getOrderSettings()
     .setRetrySettings(
         orderServiceSettingsBuilder
             .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());
 OrderServiceStubSettings orderServiceSettings = orderServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > OrderServiceStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getLibraryMetadata()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.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

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()

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 OrderServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
OrderServiceStubSettings.Builder

newBuilder(@Nullable ClientContext clientContext)

public static OrderServiceStubSettings.Builder newBuilder(@Nullable ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ClientContext

Returns
Type	Description
OrderServiceStubSettings.Builder

Constructors

OrderServiceStubSettings(OrderServiceStubSettings.Builder settingsBuilder)

protected OrderServiceStubSettings(OrderServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	OrderServiceStubSettings.Builder

Methods

batchApproveAndOverbookOrdersSettings()

public UnaryCallSettings<BatchApproveAndOverbookOrdersRequest,BatchApproveAndOverbookOrdersResponse> batchApproveAndOverbookOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchApproveAndOverbookOrdersRequest,BatchApproveAndOverbookOrdersResponse>

batchApproveOrdersSettings()

public UnaryCallSettings<BatchApproveOrdersRequest,BatchApproveOrdersResponse> batchApproveOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchApproveOrdersRequest,BatchApproveOrdersResponse>

batchApproveOrdersWithoutReservationSettings()

public UnaryCallSettings<BatchApproveOrdersWithoutReservationRequest,BatchApproveOrdersWithoutReservationResponse> batchApproveOrdersWithoutReservationSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchApproveOrdersWithoutReservationRequest,BatchApproveOrdersWithoutReservationResponse>

batchArchiveOrdersSettings()

public UnaryCallSettings<BatchArchiveOrdersRequest,BatchArchiveOrdersResponse> batchArchiveOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchArchiveOrdersRequest,BatchArchiveOrdersResponse>

batchCreateOrdersSettings()

public UnaryCallSettings<BatchCreateOrdersRequest,BatchCreateOrdersResponse> batchCreateOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchCreateOrdersRequest,BatchCreateOrdersResponse>

batchDeleteOrdersSettings()

public UnaryCallSettings<BatchDeleteOrdersRequest,BatchDeleteOrdersResponse> batchDeleteOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchDeleteOrdersRequest,BatchDeleteOrdersResponse>

batchDisapproveOrdersSettings()

public UnaryCallSettings<BatchDisapproveOrdersRequest,BatchDisapproveOrdersResponse> batchDisapproveOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchDisapproveOrdersRequest,BatchDisapproveOrdersResponse>

batchDisapproveOrdersWithoutReservationChangesSettings()

public UnaryCallSettings<BatchDisapproveOrdersWithoutReservationChangesRequest,BatchDisapproveOrdersWithoutReservationChangesResponse> batchDisapproveOrdersWithoutReservationChangesSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchDisapproveOrdersWithoutReservationChangesRequest,BatchDisapproveOrdersWithoutReservationChangesResponse>

batchPauseOrdersSettings()

public UnaryCallSettings<BatchPauseOrdersRequest,BatchPauseOrdersResponse> batchPauseOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchPauseOrdersRequest,BatchPauseOrdersResponse>

batchResumeAndOverbookOrdersSettings()

public UnaryCallSettings<BatchResumeAndOverbookOrdersRequest,BatchResumeAndOverbookOrdersResponse> batchResumeAndOverbookOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchResumeAndOverbookOrdersRequest,BatchResumeAndOverbookOrdersResponse>

batchResumeOrdersSettings()

public UnaryCallSettings<BatchResumeOrdersRequest,BatchResumeOrdersResponse> batchResumeOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchResumeOrdersRequest,BatchResumeOrdersResponse>

batchRetractOrdersSettings()

public UnaryCallSettings<BatchRetractOrdersRequest,BatchRetractOrdersResponse> batchRetractOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchRetractOrdersRequest,BatchRetractOrdersResponse>

batchRetractOrdersWithoutReservationChangesSettings()

public UnaryCallSettings<BatchRetractOrdersWithoutReservationChangesRequest,BatchRetractOrdersWithoutReservationChangesResponse> batchRetractOrdersWithoutReservationChangesSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchRetractOrdersWithoutReservationChangesRequest,BatchRetractOrdersWithoutReservationChangesResponse>

batchSubmitOrdersForApprovalAndOverbookSettings()

public UnaryCallSettings<BatchSubmitOrdersForApprovalAndOverbookRequest,BatchSubmitOrdersForApprovalAndOverbookResponse> batchSubmitOrdersForApprovalAndOverbookSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchSubmitOrdersForApprovalAndOverbookRequest,BatchSubmitOrdersForApprovalAndOverbookResponse>

batchSubmitOrdersForApprovalSettings()

public UnaryCallSettings<BatchSubmitOrdersForApprovalRequest,BatchSubmitOrdersForApprovalResponse> batchSubmitOrdersForApprovalSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchSubmitOrdersForApprovalRequest,BatchSubmitOrdersForApprovalResponse>

batchSubmitOrdersForApprovalWithoutReservationChangesSettings()

public UnaryCallSettings<BatchSubmitOrdersForApprovalWithoutReservationChangesRequest,BatchSubmitOrdersForApprovalWithoutReservationChangesResponse> batchSubmitOrdersForApprovalWithoutReservationChangesSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchSubmitOrdersForApprovalWithoutReservationChangesRequest,BatchSubmitOrdersForApprovalWithoutReservationChangesResponse>

batchUnarchiveOrdersSettings()

public UnaryCallSettings<BatchUnarchiveOrdersRequest,BatchUnarchiveOrdersResponse> batchUnarchiveOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchUnarchiveOrdersRequest,BatchUnarchiveOrdersResponse>

batchUpdateOrdersSettings()

public UnaryCallSettings<BatchUpdateOrdersRequest,BatchUpdateOrdersResponse> batchUpdateOrdersSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchUpdateOrdersRequest,BatchUpdateOrdersResponse>

createStub()

public OrderServiceStub createStub()

Returns
Type	Description
OrderServiceStub

Exceptions
Type	Description
IOException

getLibraryMetadata()

protected LibraryMetadata getLibraryMetadata()

Returns
Type	Description
LibraryMetadata

Overrides

StubSettings<SettingsT>.getLibraryMetadata()

getOrderSettings()

public UnaryCallSettings<GetOrderRequest,Order> getOrderSettings()

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

Returns
Type	Description
UnaryCallSettings<GetOrderRequest,Order>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

listOrdersSettings()

public PagedCallSettings<ListOrdersRequest,ListOrdersResponse,OrderServiceClient.ListOrdersPagedResponse> listOrdersSettings()

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

Returns
Type	Description
PagedCallSettings<ListOrdersRequest,ListOrdersResponse,ListOrdersPagedResponse>

toBuilder()

public OrderServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
OrderServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()