Class IndexServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<IndexServiceStubSettings>
com.google.cloud.aiplatform.v1.stub.IndexServiceStubSettings
@Generated("by gapic-generator-java")
public class IndexServiceStubSettings
extends StubSettings<IndexServiceStubSettings>
Settings class to configure an instance of
IndexServiceStub.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getIndex:
// 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
IndexServiceStubSettings.Builder indexServiceSettingsBuilder =
IndexServiceStubSettings.newBuilder();
indexServiceSettingsBuilder
.getIndexSettings()
.setRetrySettings(
indexServiceSettingsBuilder
.getIndexSettings()
.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());
IndexServiceStubSettings indexServiceSettings = indexServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createIndex:
// 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
IndexServiceStubSettings.Builder indexServiceSettingsBuilder =
IndexServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
indexServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for IndexServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedIndexServiceStubSettings(IndexServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createIndex.Returns the object with the settings used for calls to createIndex.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteIndexRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteIndex.Returns the object with the settings used for calls to deleteIndex.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getIndex.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.PagedCallSettings<ListIndexesRequest,ListIndexesResponse, IndexServiceClient.ListIndexesPagedResponse> Returns the object with the settings used for calls to listIndexes.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, IndexServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to removeDatapoints.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateIndex.Returns the object with the settings used for calls to updateIndex.Returns the object with the settings used for calls to upsertDatapoints.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
IndexServiceStubSettings
protected IndexServiceStubSettings(IndexServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createIndexSettings
Returns the object with the settings used for calls to createIndex. -
createIndexOperationSettings
public OperationCallSettings<CreateIndexRequest,Index, createIndexOperationSettings()CreateIndexOperationMetadata> Returns the object with the settings used for calls to createIndex. -
getIndexSettings
Returns the object with the settings used for calls to getIndex. -
listIndexesSettings
public PagedCallSettings<ListIndexesRequest,ListIndexesResponse, listIndexesSettings()IndexServiceClient.ListIndexesPagedResponse> Returns the object with the settings used for calls to listIndexes. -
updateIndexSettings
Returns the object with the settings used for calls to updateIndex. -
updateIndexOperationSettings
public OperationCallSettings<UpdateIndexRequest,Index, updateIndexOperationSettings()UpdateIndexOperationMetadata> Returns the object with the settings used for calls to updateIndex. -
deleteIndexSettings
Returns the object with the settings used for calls to deleteIndex. -
deleteIndexOperationSettings
public OperationCallSettings<DeleteIndexRequest,com.google.protobuf.Empty, deleteIndexOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteIndex. -
upsertDatapointsSettings
public UnaryCallSettings<UpsertDatapointsRequest,UpsertDatapointsResponse> upsertDatapointsSettings()Returns the object with the settings used for calls to upsertDatapoints. -
removeDatapointsSettings
public UnaryCallSettings<RemoveDatapointsRequest,RemoveDatapointsResponse> removeDatapointsSettings()Returns the object with the settings used for calls to removeDatapoints. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()IndexServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<IndexServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<IndexServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<IndexServiceStubSettings>
-