Class YieldPartnerServiceSettings (0.62.0)

public class YieldPartnerServiceSettings extends ClientSettings<YieldPartnerServiceSettings>

Settings class to configure an instance of YieldPartnerServiceClient.

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


 // 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
 YieldPartnerServiceSettings.Builder yieldPartnerServiceSettingsBuilder =
     YieldPartnerServiceSettings.newBuilder();
 yieldPartnerServiceSettingsBuilder
     .getYieldPartnerSettings()
     .setRetrySettings(
         yieldPartnerServiceSettingsBuilder
             .getYieldPartnerSettings()
             .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());
 YieldPartnerServiceSettings yieldPartnerServiceSettings =
     yieldPartnerServiceSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > ClientSettings > YieldPartnerServiceSettings

Static Methods

create(YieldPartnerServiceStubSettings stub)

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

Returns a new builder for this class.

Returns
Type Description
YieldPartnerServiceSettings.Builder

newBuilder(@Nullable ClientContext clientContext)

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

Constructors

YieldPartnerServiceSettings(YieldPartnerServiceSettings.Builder settingsBuilder)

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

Methods

getYieldPartnerSettings()

public UnaryCallSettings<GetYieldPartnerRequest,YieldPartner> getYieldPartnerSettings()

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

Returns
Type Description
UnaryCallSettings<GetYieldPartnerRequest,YieldPartner>

listYieldPartnersSettings()

public PagedCallSettings<ListYieldPartnersRequest,ListYieldPartnersResponse,YieldPartnerServiceClient.ListYieldPartnersPagedResponse> listYieldPartnersSettings()

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

Returns
Type Description
PagedCallSettings<ListYieldPartnersRequest,ListYieldPartnersResponse,ListYieldPartnersPagedResponse>

toBuilder()

public YieldPartnerServiceSettings.Builder toBuilder()

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

Returns
Type Description
YieldPartnerServiceSettings.Builder
Overrides