Class AdReviewCenterAdServiceStubSettings (0.39.0)

public class AdReviewCenterAdServiceStubSettings extends StubSettings<AdReviewCenterAdServiceStubSettings>

Settings class to configure an instance of AdReviewCenterAdServiceStub.

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


 // 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
 AdReviewCenterAdServiceStubSettings.Builder adReviewCenterAdServiceSettingsBuilder =
     AdReviewCenterAdServiceStubSettings.newBuilder();
 adReviewCenterAdServiceSettingsBuilder
     .searchAdReviewCenterAdsSettings()
     .setRetrySettings(
         adReviewCenterAdServiceSettingsBuilder
             .searchAdReviewCenterAdsSettings()
             .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());
 AdReviewCenterAdServiceStubSettings adReviewCenterAdServiceSettings =
     adReviewCenterAdServiceSettingsBuilder.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 batchAllowAdReviewCenterAds:


 // 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
 AdReviewCenterAdServiceStubSettings.Builder adReviewCenterAdServiceSettingsBuilder =
     AdReviewCenterAdServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 adReviewCenterAdServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > StubSettings > AdReviewCenterAdServiceStubSettings

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

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 AdReviewCenterAdServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
AdReviewCenterAdServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static AdReviewCenterAdServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
AdReviewCenterAdServiceStubSettings.Builder

Constructors

AdReviewCenterAdServiceStubSettings(AdReviewCenterAdServiceStubSettings.Builder settingsBuilder)

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

Methods

batchAllowAdReviewCenterAdsOperationSettings()

public OperationCallSettings<BatchAllowAdReviewCenterAdsRequest,BatchAllowAdReviewCenterAdsResponse,BatchAdReviewCenterAdsOperationMetadata> batchAllowAdReviewCenterAdsOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchAllowAdReviewCenterAdsRequest,BatchAllowAdReviewCenterAdsResponse,BatchAdReviewCenterAdsOperationMetadata>

batchAllowAdReviewCenterAdsSettings()

public UnaryCallSettings<BatchAllowAdReviewCenterAdsRequest,Operation> batchAllowAdReviewCenterAdsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchAllowAdReviewCenterAdsRequest,Operation>

batchBlockAdReviewCenterAdsOperationSettings()

public OperationCallSettings<BatchBlockAdReviewCenterAdsRequest,BatchBlockAdReviewCenterAdsResponse,BatchAdReviewCenterAdsOperationMetadata> batchBlockAdReviewCenterAdsOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchBlockAdReviewCenterAdsRequest,BatchBlockAdReviewCenterAdsResponse,BatchAdReviewCenterAdsOperationMetadata>

batchBlockAdReviewCenterAdsSettings()

public UnaryCallSettings<BatchBlockAdReviewCenterAdsRequest,Operation> batchBlockAdReviewCenterAdsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchBlockAdReviewCenterAdsRequest,Operation>

createStub()

public AdReviewCenterAdServiceStub createStub()
Returns
Type Description
AdReviewCenterAdServiceStub
Exceptions
Type Description
IOException

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

searchAdReviewCenterAdsSettings()

public PagedCallSettings<SearchAdReviewCenterAdsRequest,SearchAdReviewCenterAdsResponse,AdReviewCenterAdServiceClient.SearchAdReviewCenterAdsPagedResponse> searchAdReviewCenterAdsSettings()

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

Returns
Type Description
PagedCallSettings<SearchAdReviewCenterAdsRequest,SearchAdReviewCenterAdsResponse,SearchAdReviewCenterAdsPagedResponse>

toBuilder()

public AdReviewCenterAdServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
AdReviewCenterAdServiceStubSettings.Builder
Overrides