Class ReasoningEngineServiceStubSettings (3.56.0)

public class ReasoningEngineServiceStubSettings extends StubSettings<ReasoningEngineServiceStubSettings>

Settings class to configure an instance of ReasoningEngineServiceStub.

The default instance has everything set to sensible defaults:

The default service address (aiplatform.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 getReasoningEngine:


 // 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
 ReasoningEngineServiceStubSettings.Builder reasoningEngineServiceSettingsBuilder =
     ReasoningEngineServiceStubSettings.newBuilder();
 reasoningEngineServiceSettingsBuilder
     .getReasoningEngineSettings()
     .setRetrySettings(
         reasoningEngineServiceSettingsBuilder
             .getReasoningEngineSettings()
             .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());
 ReasoningEngineServiceStubSettings reasoningEngineServiceSettings =
     reasoningEngineServiceSettingsBuilder.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 createReasoningEngine:


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

Inheritance

java.lang.Object > StubSettings > ReasoningEngineServiceStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

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`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns a new builder for this class.

Returns
Type	Description
`ReasoningEngineServiceStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static ReasoningEngineServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`ReasoningEngineServiceStubSettings.Builder`

Constructors

ReasoningEngineServiceStubSettings(ReasoningEngineServiceStubSettings.Builder settingsBuilder)

protected ReasoningEngineServiceStubSettings(ReasoningEngineServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`ReasoningEngineServiceStubSettings.Builder`

Methods

createReasoningEngineOperationSettings()

public OperationCallSettings<CreateReasoningEngineRequest,ReasoningEngine,CreateReasoningEngineOperationMetadata> createReasoningEngineOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateReasoningEngineRequest,ReasoningEngine,CreateReasoningEngineOperationMetadata>`

createReasoningEngineSettings()

public UnaryCallSettings<CreateReasoningEngineRequest,Operation> createReasoningEngineSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateReasoningEngineRequest,Operation>`

createStub()

public ReasoningEngineServiceStub createStub()

Returns
Type	Description
`ReasoningEngineServiceStub`

Exceptions
Type	Description
`IOException`

deleteReasoningEngineOperationSettings()

public OperationCallSettings<DeleteReasoningEngineRequest,Empty,DeleteOperationMetadata> deleteReasoningEngineOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteReasoningEngineRequest,Empty,DeleteOperationMetadata>`

deleteReasoningEngineSettings()

public UnaryCallSettings<DeleteReasoningEngineRequest,Operation> deleteReasoningEngineSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteReasoningEngineRequest,Operation>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getReasoningEngineSettings()

public UnaryCallSettings<GetReasoningEngineRequest,ReasoningEngine> getReasoningEngineSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetReasoningEngineRequest,ReasoningEngine>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ReasoningEngineServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
`PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>`

listReasoningEnginesSettings()

public PagedCallSettings<ListReasoningEnginesRequest,ListReasoningEnginesResponse,ReasoningEngineServiceClient.ListReasoningEnginesPagedResponse> listReasoningEnginesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListReasoningEnginesRequest,ListReasoningEnginesResponse,ListReasoningEnginesPagedResponse>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

toBuilder()

public ReasoningEngineServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
`ReasoningEngineServiceStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateReasoningEngineOperationSettings()

public OperationCallSettings<UpdateReasoningEngineRequest,ReasoningEngine,UpdateReasoningEngineOperationMetadata> updateReasoningEngineOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateReasoningEngineRequest,ReasoningEngine,UpdateReasoningEngineOperationMetadata>`

updateReasoningEngineSettings()

public UnaryCallSettings<UpdateReasoningEngineRequest,Operation> updateReasoningEngineSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateReasoningEngineRequest,Operation>`