Class RuleSetServiceSettings (0.51.0) 

public class RuleSetServiceSettings extends ClientSettings<RuleSetServiceSettings>

Settings class to configure an instance of RuleSetServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (contentwarehouse.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 createRuleSet:


 // 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
 RuleSetServiceSettings.Builder ruleSetServiceSettingsBuilder =
     RuleSetServiceSettings.newBuilder();
 ruleSetServiceSettingsBuilder
     .createRuleSetSettings()
     .setRetrySettings(
         ruleSetServiceSettingsBuilder
             .createRuleSetSettings()
             .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());
 RuleSetServiceSettings ruleSetServiceSettings = ruleSetServiceSettingsBuilder.build();

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

Inheritance

java.lang.Object > ClientSettings > RuleSetServiceSettings

Static Methods

create(RuleSetServiceStubSettings stub)

public static final RuleSetServiceSettings create(RuleSetServiceStubSettings stub)
Parameter
Name Description
stub RuleSetServiceStubSettings
Returns
Type Description
RuleSetServiceSettings
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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 RuleSetServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
RuleSetServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static RuleSetServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
RuleSetServiceSettings.Builder

newHttpJsonBuilder()

public static RuleSetServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
RuleSetServiceSettings.Builder

Constructors

RuleSetServiceSettings(RuleSetServiceSettings.Builder settingsBuilder)

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

Methods

createRuleSetSettings()

public UnaryCallSettings<CreateRuleSetRequest,RuleSet> createRuleSetSettings()

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

Returns
Type Description
UnaryCallSettings<CreateRuleSetRequest,RuleSet>

deleteRuleSetSettings()

public UnaryCallSettings<DeleteRuleSetRequest,Empty> deleteRuleSetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteRuleSetRequest,Empty>

getRuleSetSettings()

public UnaryCallSettings<GetRuleSetRequest,RuleSet> getRuleSetSettings()

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

Returns
Type Description
UnaryCallSettings<GetRuleSetRequest,RuleSet>

listRuleSetsSettings()

public PagedCallSettings<ListRuleSetsRequest,ListRuleSetsResponse,RuleSetServiceClient.ListRuleSetsPagedResponse> listRuleSetsSettings()

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

Returns
Type Description
PagedCallSettings<ListRuleSetsRequest,ListRuleSetsResponse,ListRuleSetsPagedResponse>

toBuilder()

public RuleSetServiceSettings.Builder toBuilder()

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

Returns
Type Description
RuleSetServiceSettings.Builder
Overrides

updateRuleSetSettings()

public UnaryCallSettings<UpdateRuleSetRequest,RuleSet> updateRuleSetSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateRuleSetRequest,RuleSet>