Class ProposalServiceSettings (0.62.0)

public class ProposalServiceSettings extends ClientSettings<ProposalServiceSettings>

Settings class to configure an instance of ProposalServiceClient.

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 getProposal:


 // 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
 ProposalServiceSettings.Builder proposalServiceSettingsBuilder =
     ProposalServiceSettings.newBuilder();
 proposalServiceSettingsBuilder
     .getProposalSettings()
     .setRetrySettings(
         proposalServiceSettingsBuilder
             .getProposalSettings()
             .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());
 ProposalServiceSettings proposalServiceSettings = proposalServiceSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > ClientSettings > ProposalServiceSettings

Static Methods

create(ProposalServiceStubSettings stub)

public static final ProposalServiceSettings create(ProposalServiceStubSettings stub)
Parameter
Name Description
stub ProposalServiceStubSettings
Returns
Type Description
ProposalServiceSettings
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 ProposalServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
ProposalServiceSettings.Builder

newBuilder(@Nullable ClientContext clientContext)

public static ProposalServiceSettings.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
ProposalServiceSettings.Builder

Constructors

ProposalServiceSettings(ProposalServiceSettings.Builder settingsBuilder)

protected ProposalServiceSettings(ProposalServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder ProposalServiceSettings.Builder

Methods

batchArchiveProposalsSettings()

public UnaryCallSettings<BatchArchiveProposalsRequest,BatchArchiveProposalsResponse> batchArchiveProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchArchiveProposalsRequest,BatchArchiveProposalsResponse>

batchCreateProposalsSettings()

public UnaryCallSettings<BatchCreateProposalsRequest,BatchCreateProposalsResponse> batchCreateProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreateProposalsRequest,BatchCreateProposalsResponse>

batchDiscardDraftProposalsSettings()

public UnaryCallSettings<BatchDiscardDraftProposalsRequest,BatchDiscardDraftProposalsResponse> batchDiscardDraftProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchDiscardDraftProposalsRequest,BatchDiscardDraftProposalsResponse>

batchPauseProposalsSettings()

public UnaryCallSettings<BatchPauseProposalsRequest,BatchPauseProposalsResponse> batchPauseProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchPauseProposalsRequest,BatchPauseProposalsResponse>

batchPushToOrderProposalsSettings()

public UnaryCallSettings<BatchPushToOrderProposalsRequest,BatchPushToOrderProposalsResponse> batchPushToOrderProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchPushToOrderProposalsRequest,BatchPushToOrderProposalsResponse>

batchRedraftProposalsSettings()

public UnaryCallSettings<BatchRedraftProposalsRequest,BatchRedraftProposalsResponse> batchRedraftProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchRedraftProposalsRequest,BatchRedraftProposalsResponse>

batchRequestBuyerAcceptProposalsSettings()

public UnaryCallSettings<BatchRequestBuyerAcceptProposalsRequest,BatchRequestBuyerAcceptProposalsResponse> batchRequestBuyerAcceptProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchRequestBuyerAcceptProposalsRequest,BatchRequestBuyerAcceptProposalsResponse>

batchRequestBuyerReviewProposalsSettings()

public UnaryCallSettings<BatchRequestBuyerReviewProposalsRequest,BatchRequestBuyerReviewProposalsResponse> batchRequestBuyerReviewProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchRequestBuyerReviewProposalsRequest,BatchRequestBuyerReviewProposalsResponse>

batchReserveProposalsSettings()

public UnaryCallSettings<BatchReserveProposalsRequest,BatchReserveProposalsResponse> batchReserveProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchReserveProposalsRequest,BatchReserveProposalsResponse>

batchResumeProposalsSettings()

public UnaryCallSettings<BatchResumeProposalsRequest,BatchResumeProposalsResponse> batchResumeProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchResumeProposalsRequest,BatchResumeProposalsResponse>

batchTerminateProposalsSettings()

public UnaryCallSettings<BatchTerminateProposalsRequest,BatchTerminateProposalsResponse> batchTerminateProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchTerminateProposalsRequest,BatchTerminateProposalsResponse>

batchUnarchiveProposalsSettings()

public UnaryCallSettings<BatchUnarchiveProposalsRequest,BatchUnarchiveProposalsResponse> batchUnarchiveProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUnarchiveProposalsRequest,BatchUnarchiveProposalsResponse>

batchUpdateProposalsSettings()

public UnaryCallSettings<BatchUpdateProposalsRequest,BatchUpdateProposalsResponse> batchUpdateProposalsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchUpdateProposalsRequest,BatchUpdateProposalsResponse>

createProposalSettings()

public UnaryCallSettings<CreateProposalRequest,Proposal> createProposalSettings()

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

Returns
Type Description
UnaryCallSettings<CreateProposalRequest,Proposal>

fetchMarketplaceCommentsSettings()

public PagedCallSettings<FetchMarketplaceCommentsRequest,FetchMarketplaceCommentsResponse,ProposalServiceClient.FetchMarketplaceCommentsPagedResponse> fetchMarketplaceCommentsSettings()

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

Returns
Type Description
PagedCallSettings<FetchMarketplaceCommentsRequest,FetchMarketplaceCommentsResponse,FetchMarketplaceCommentsPagedResponse>

getProposalSettings()

public UnaryCallSettings<GetProposalRequest,Proposal> getProposalSettings()

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

Returns
Type Description
UnaryCallSettings<GetProposalRequest,Proposal>

listProposalsSettings()

public PagedCallSettings<ListProposalsRequest,ListProposalsResponse,ProposalServiceClient.ListProposalsPagedResponse> listProposalsSettings()

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

Returns
Type Description
PagedCallSettings<ListProposalsRequest,ListProposalsResponse,ListProposalsPagedResponse>

toBuilder()

public ProposalServiceSettings.Builder toBuilder()

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

Returns
Type Description
ProposalServiceSettings.Builder
Overrides

updateProposalSettings()

public UnaryCallSettings<UpdateProposalRequest,Proposal> updateProposalSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateProposalRequest,Proposal>